Struct StepEvent 

pub struct StepEvent<S: EngineSpec> {
    pub spec: String,
    pub execution_id: ExecutionUuid,
    pub event_index: usize,
    pub total_elapsed: Duration,
    pub kind: StepEventKind<S>,
}

Fields

spec: String

The specification that this event belongs to.

This is typically the name of the type S for which EngineSpec is implemented.

This can be used along with Self::from_generic to identify which specification to deserialize generic metadata against. For example:

if event.spec == "MySpec" {
    // event is likely generated from a MySpec engine.
    let event = Event::<MySpec>::from_generic(event)?;
    // ...
}

execution_id: ExecutionUuid

The execution ID.

event_index: usize

A monotonically increasing index for this StepEvent.

total_elapsed: Duration

Total time elapsed since the start of execution.

kind: StepEventKind<S>

The kind of event this is.

Implementations

impl<S: EngineSpec> StepEvent<S>

pub fn progress_event(&self) -> Option<ProgressEvent<S>>

Returns a progress event associated with this step event, if any.

Some step events have an implicit progress event of kind ProgressEventKind::WaitingForProgress associated with them. This causes those step events to generate progress events.

pub fn leaf_execution_id(&self) -> ExecutionUuid

Returns the execution ID for the leaf event, recursing into nested events if necessary.

pub fn leaf_event_index(&self) -> usize

Returns the event index for the leaf event, recursing into nested events if necessary.

pub fn from_generic( value: StepEvent<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) -> StepEvent<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 StepEvent<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 StepEvent<S>

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

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<S: JsonSchemaEngineSpec> JsonSchema for StepEvent<S>

Available on crate feature schemars08 only.

fn schema_name() -> String

The name of the generated JSON Schema.

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.

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

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

impl<S: EngineSpec> PartialEq for StepEvent<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 StepEvent<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 StepEvent<S>