Enum ProgressEventKind 

pub enum ProgressEventKind<S: EngineSpec> {
    WaitingForProgress {
        step: StepInfoWithMetadata<S>,
        attempt: usize,
        step_elapsed: Duration,
        attempt_elapsed: Duration,
    },
    Progress {
        step: StepInfoWithMetadata<S>,
        attempt: usize,
        metadata: S::ProgressMetadata,
        progress: Option<ProgressCounter>,
        step_elapsed: Duration,
        attempt_elapsed: Duration,
    },
    Nested {
        step: StepInfoWithMetadata<S>,
        attempt: usize,
        event: Box<ProgressEvent<GenericSpec>>,
        step_elapsed: Duration,
        attempt_elapsed: Duration,
    },
    Unknown,
}

Variants

WaitingForProgress

The update engine is waiting for a progress message.

The update engine sends this message immediately after a StepEvent corresponding to a new step.

Fields

step: StepInfoWithMetadata<S>

Information about the step.

attempt: usize

The attempt number currently being executed.

step_elapsed: Duration

Total time elapsed since the start of the step. Includes prior attempts.

attempt_elapsed: Duration

Total time elapsed since the start of the attempt.

Progress

Fields

step: StepInfoWithMetadata<S>

Information about the step.

attempt: usize

The attempt number currently being executed.

metadata: S::ProgressMetadata

Metadata that was returned with progress.

progress: Option<ProgressCounter>

Current progress.

step_elapsed: Duration

Total time elapsed since the start of the step. Includes prior attempts.

attempt_elapsed: Duration

Total time elapsed since the start of the attempt.

Nested

Fields

step: StepInfoWithMetadata<S>

Information about the step.

attempt: usize

The attempt number currently being executed.

event: Box<ProgressEvent<GenericSpec>>

The event that occurred.

step_elapsed: Duration

Total time elapsed since the start of the step. Includes prior attempts.

attempt_elapsed: Duration

The time it took for this attempt to complete.

Unknown

Future variants that might be unknown.

Implementations

impl<S: EngineSpec> ProgressEventKind<S>

pub fn progress_counter(&self) -> Option<&ProgressCounter>

Returns the progress counter for this event, if available.

pub fn leaf_attempt(&self) -> Option<usize>

Returns attempt for the leaf event, recursing into nested events as necessary.

Returns None for unknown events.

pub fn leaf_step_elapsed(&self) -> Option<Duration>

Returns step_elapsed for the leaf event, recursing into nested events as necessary.

Returns None for unknown events.

pub fn leaf_attempt_elapsed(&self) -> Option<Duration>

Returns attempt_elapsed for the leaf event, recursing into nested events as necessary.

Returns None for unknown events.

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

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

Formats the value using the given formatter.

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