Struct ExecutionTrace 

#[non_exhaustive]
pub struct ExecutionTrace {
    pub steps: Vec<ExecutionStep>,
    /* private fields */
}

Complete execution trace containing all steps

#[non_exhaustive]: construct with ExecutionTrace::new or ExecutionTrace::with_options. steps stays public for reads.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

steps: Vec<ExecutionStep>

All execution steps in order

Implementations

impl ExecutionTrace

pub fn new() -> Self

Create a new empty execution trace with default capture policy.

pub fn with_options(options: TraceOptions) -> Self

Empty trace that records according to options.

pub fn options(&self) -> &TraceOptions

The capture policy this trace records with.

pub fn truncated(&self) -> bool

Whether TraceOptions::max_snapshot_bytes was exceeded, and one or more executed steps therefore carry message: None, missing mapping contexts, or both.

The budget is shared across both: with TraceOptions::snapshots off but TraceOptions::mapping_contexts on, this can still return true from the mapping-context term alone, even though no step was ever going to carry a message.

pub fn add_step(&mut self, step: ExecutionStep)

Add a step to the trace

pub fn final_message(&self) -> Option<&Message>

Get the final message (from the last executed step)

Returns None when TraceOptions::snapshots is off, or when every executed step was recorded after the snapshot budget was exceeded.

pub fn is_success(&self) -> bool

Check if execution was successful (no errors in final message)

Degenerates to true when there is no snapshot to inspect — with TraceOptions::snapshots off, read Message::errors on the message you passed in instead.

pub fn executed_count(&self) -> usize

Get number of executed steps

pub fn skipped_count(&self) -> usize

Get number of skipped steps

Trait Implementations

impl Clone for ExecutionTrace

fn clone(&self) -> ExecutionTrace

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExecutionTrace

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

Formats the value using the given formatter.

impl Default for ExecutionTrace

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ExecutionTrace

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ExecutionTrace

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

where __S: Serializer,

Serialize this value into the given Serde serializer.