Struct StepSuccess 

pub struct StepSuccess<T, S: EngineSpec> {
    pub output: T,
    pub message: Option<Cow<'static, str>>,
    pub metadata: Option<S::CompletionMetadata>,
}

A success result produced by a step.

Fields

output: T

The output of the step.

message: Option<Cow<'static, str>>

An optional message associated with this result.

metadata: Option<S::CompletionMetadata>

Optional metadata associated with this step.

Implementations

impl<T, S: EngineSpec> StepSuccess<T, S>

pub fn new(output: T) -> Self

Creates a new StepSuccess.

pub fn with_message(self, message: impl Into<Cow<'static, str>>) -> Self

Adds a message to this step.

pub fn with_metadata(self, metadata: S::CompletionMetadata) -> Self

Adds metadata to this step.

pub fn build(self) -> StepResult<T, S>

Creates a StepResult from this StepSuccess.

Trait Implementations

impl<T, S: EngineSpec> Debug for StepSuccess<T, S>

where T: Debug,

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

Formats the value using the given formatter.

impl<T, S: EngineSpec> From<StepSuccess<T, S>> for Result<StepResult<T, S>, S::Error>

fn from(value: StepSuccess<T, S>) -> Self

Converts to this type from the input type.