Struct StepInfo 

pub struct StepInfo<S: EngineSpec> {
    pub id: S::StepId,
    pub component: S::Component,
    pub description: Cow<'static, str>,
    pub index: usize,
    pub component_index: usize,
    pub total_component_steps: usize,
}

Serializable information about a step.

Fields

id: S::StepId

An identifier for this step.

component: S::Component

The component that this step is part of.

description: Cow<'static, str>

The description for this step.

index: usize

The index of the step within all steps to be executed.

component_index: usize

The index of the step within the component.

total_component_steps: usize

The total number of steps in this component.

Implementations

impl<S: EngineSpec> StepInfo<S>

pub fn is_last_step_in_component(&self) -> bool

Returns true if this is the last step in this component.

pub fn from_generic( value: StepInfo<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 into_generic(self) -> StepInfo<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.

Trait Implementations

impl<S: EngineSpec> Clone for StepInfo<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 StepInfo<S>

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

Formats the value using the given formatter.

impl<'de, S: EngineSpec> Deserialize<'de> for StepInfo<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 StepInfo<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 StepInfo<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 StepInfo<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 StepInfo<S>