Skip to main content

NodeOutcome

Enum NodeOutcome 

Source
pub enum NodeOutcome {
    Produced(Value),
    HandOff {
        target: String,
        carry: Value,
    },
    Paused {
        turn: usize,
        reason: SuspendReason,
    },
}
Expand description

How a node finished.

The three ways execution can leave a node, whichever kind it was. A filter only ever produces; a step can also hand control on or stop and wait. The runtime used to carry this as StepOutcome and translate it three times on the way out — into control flow, then into an error with the reason flattened to a JSON string that nothing parsed back.

Deliberately not #[non_exhaustive], against the convention for public enums here. Every consumer of this type is deciding control flow, and a wildcard arm in that position is a silent wrong answer — the pattern that let an unhandled plan variant become a successful no-op. If a fourth way to finish is ever added, the places that must think about it should stop compiling.

Variants§

§

Produced(Value)

A value, which the node’s successors read as its output.

§

HandOff

Control passes to another node, carrying a value.

The carry is stored under the handing node, so the target reads it as an ordinary predecessor output rather than through a special path.

Fields

§target: String

The node control passes to; must have been declared as a handoff.

§carry: Value

The value the target reads as this node’s output.

§

Paused

The run stopped, pending something outside it. turn is where to deliver the answer when resuming.

Fields

§turn: usize

The step’s turn counter at suspension — resume delivers here.

§reason: SuspendReason

What the run is waiting for (a person, an external event).

Trait Implementations§

Source§

impl Debug for NodeOutcome

Source§

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

Formats the value using the given formatter. Read more

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> AsAny for T
where T: Any,

Source§

fn as_any(&self) -> &(dyn Any + 'static)

The receiver as &dyn Any, ready for downcast_ref.
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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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