Enum AuditMode 

#[non_exhaustive]
pub enum AuditMode {
    Full,
    Last(usize),
    Off,
}

How many AuditTrail entries a Message keeps.

The engine records one entry per executed task, and in a looping workflow that is one per task per sweep, all kept until process_message returns. A host that never reads Message::audit_trail (because it traces, or reads metadata.progress) can bound or drop them. Set it with MessageBuilder::audit_mode.

The mode changes only what is kept. Status classification, error records, metadata.progress, halting and the observer are identical in every mode.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Full

Keep every entry. The default.

Last(usize)

Keep the most recent n entries. Last(0) keeps none, like Self::Off.

Older entries are dropped in batches, so the message holds at most 2n entries in memory while Message::audit_trail always shows the last n.

Off

Keep no entries.

A trace’s per-step changes are read from the task’s own entry, so they come back empty in this mode, as they do with capture_changes off. Turn capture_changes off too: with no entry to hold them, the captured copies would be made and dropped for nothing.

Trait Implementations

impl Clone for AuditMode

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for AuditMode

impl Debug for AuditMode

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

Formats the value using the given formatter.

impl Default for AuditMode

fn default() -> Self

Returns the “default value” for a type.

impl Eq for AuditMode

impl PartialEq for AuditMode

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for AuditMode