Enum StepOutcome 

pub enum StepOutcome<S: EngineSpec> {
    Success {
        message: Option<Cow<'static, str>>,
        metadata: Option<S::CompletionMetadata>,
    },
    Warning {
        message: Cow<'static, str>,
        metadata: Option<S::CompletionMetadata>,
    },
    Skipped {
        message: Cow<'static, str>,
        metadata: Option<S::SkippedMetadata>,
    },
}

Variants

Success

The step completed successfully.

Fields

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

An optional message associated with this step.

metadata: Option<S::CompletionMetadata>

Optional completion metadata associated with the step.

Warning

The step completed with a warning.

Fields

message: Cow<'static, str>

A warning message.

metadata: Option<S::CompletionMetadata>

Optional completion metadata associated with the step.

Skipped

The step was skipped with a message.

Fields

message: Cow<'static, str>

Message associated with the skip.

metadata: Option<S::SkippedMetadata>

Optional metadata associated with the skip.

Implementations

impl<S: EngineSpec> StepOutcome<S>

pub fn from_generic( value: StepOutcome<GenericSpec>, ) -> Result<Self, ConvertGenericError>

Converts a generic version into self.

This version can be used to convert a generic type into a more concrete form.

pub fn completion_metadata(&self) -> Option<&S::CompletionMetadata>

If this outcome represents completion, returns the metadata associated with this event.

Returns None if this outcome represents “skipped”.

pub fn into_generic(self) -> StepOutcome<GenericSpec>

Converts self into its generic version.

This version can be used to share data across different kinds of engines.

If any of the data in self fails to serialize to a serde_json::Value, it will be replaced with serde_json::Value::Null. Since serde_json::Value represents an arbitrary JSON value, such data would have failed to serialize anyway.

pub fn is_success_or_warning(&self) -> bool

Returns true if the step was successful, including success with warning.

pub fn is_skipped(&self) -> bool

Returns true if the step was skipped.

pub fn message(&self) -> Option<&Cow<'static, str>>

Returns the message associated with this outcome, if one exists.

Trait Implementations

impl<S: EngineSpec> Clone for StepOutcome<S>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: EngineSpec> Debug for StepOutcome<S>

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

Formats the value using the given formatter.

impl<'de, S: EngineSpec> Deserialize<'de> for StepOutcome<S>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<S> JsonSchema for StepOutcome<S>

where S: JsonSchemaEngineSpec + EngineSpec,

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl<S: EngineSpec> PartialEq for StepOutcome<S>

fn eq(&self, __other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<S: EngineSpec> Serialize for StepOutcome<S>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<S: EngineSpec> Eq for StepOutcome<S>