Skip to main content

StepResult

Enum StepResult 

Source
pub enum StepResult {
    Pass(Event),
    Drop {
        reason: String,
        exit_reason: Option<String>,
    },
    FanOut(Vec<Event>),
    Action {
        event: Event,
        action: Box<PreparedAction>,
    },
}
Expand description

The outcome of running one event through one crate::node::StepNode.

Variants§

§

Pass(Event)

Forward the (possibly derived) event to the next step.

§

Drop

Stop propagation here. Filters and sink terminals return this.

Fields

§reason: String

Why the event stopped.

§exit_reason: Option<String>

Stable machine-readable code for material business outcomes. A routine filter drop leaves this empty.

§

FanOut(Vec<Event>)

Forward several events. Only nodes that declare produces_fan_out may return this; the validator bans fan-out upstream of execute.*.

§

Action

Persist an external action intent and continue with the supplied event. The step never invokes the provider inline.

Fields

§event: Event

Event forwarded to the next step.

§action: Box<PreparedAction>

The effect to persist as an intent.

Implementations§

Source§

impl StepResult

Source

pub fn drop(reason: impl Into<String>) -> Self

A routine drop that recorders do not persist as a step.

Source

pub fn gate(exit_reason: impl Into<String>) -> Self

A material gate/drop that recorders should persist as a run step.

Trait Implementations§

Source§

impl Clone for StepResult

Source§

fn clone(&self) -> StepResult

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 StepResult

Source§

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

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> 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> 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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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