Skip to main content

RunEnd

Enum RunEnd 

Source
pub enum RunEnd {
    Success {
        result: Option<Value>,
    },
    Interrupted {
        interrupts: Vec<Interrupt>,
    },
    Failed {
        message: String,
        code: Option<String>,
    },
}
Expand description

How a run ended.

Exhaustive, unlike Update and unlike every error in this workspace: a run ends in one of three ways because the protocol says so — RUN_FINISHED with a success outcome, RUN_FINISHED with an interrupt outcome, or RUN_ERROR (which the truncated-stream case is reported as). A fourth would be a wire-contract change, and docs/DESIGN.md explains why those are meant to be compile errors for consumers rather than something a _ arm swallows. This is the match a front-end most wants the compiler’s help with — it decides whether the input goes live again.

Variants§

§

Success

The agent finished.

Meaning “the agent said the run succeeded”, not “nothing went wrong”. The two come apart: a protocol violation the verifier caught, or a state patch that would not apply, arrives as an Update::Error and the run carries on to end here — those are the client’s diagnostics, and the agent is neither told nor asked. A view that routes on Update::Done alone will call such a run clean; track the errors as they arrive if the difference matters to you.

Fields

§result: Option<Value>

The agent’s return value, if it sent one.

§

Interrupted

The agent paused for human input. The same interrupts arrived individually as Update::Interrupt, and are on Session::interrupts until the next run.

Fields

§interrupts: Vec<Interrupt>

What the agent is waiting for.

§

Failed

The run failed, or the transport stopped before it could finish. The matching Update::Error came first.

Fields

§message: String

What went wrong, for a human.

§code: Option<String>

The machine-readable code, when the agent sent one.

Trait Implementations§

Source§

impl Clone for RunEnd

Source§

fn clone(&self) -> RunEnd

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for RunEnd

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl PartialEq for RunEnd

Source§

fn eq(&self, other: &RunEnd) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for RunEnd

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FromRef<T> for T
where T: Clone,

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more