Enum Event 

#[non_exhaustive]
pub enum Event<'a> {
    #[non_exhaustive]
    RunStarted {
        program: ProgramId,
        message_id: &'a str,
        channel: Option<&'a str>,
        considered: usize,
    },
    #[non_exhaustive]
    WorkflowStarted {
        workflow: WorkflowIx,
        id: &'a str,
    },
    #[non_exhaustive]
    TaskFinished {
        info: &'a CallInfo<'a>,
        status: Option<u16>,
        elapsed: Option<Duration>,
    },
    #[non_exhaustive]
    WorkflowFinished {
        record: &'a WorkflowRecord<'a>,
        elapsed: Option<Duration>,
    },
    #[non_exhaustive]
    RunFinished {
        message_id: &'a str,
        status: &'a RunStatus,
        errors: usize,
        elapsed: Option<Duration>,
    },
}

One event of a run, borrowed for the call to Observer::on: an observer copies out what it keeps.

An elapsed is Some only for an observer whose interest holds Interest::TIMINGS. Each variant is #[non_exhaustive]: match its fields with .., so a fact added later breaks no host.

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.

#[non_exhaustive]

RunStarted

The run starts, after its stamps, before any workflow.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

program: ProgramId

The program the run runs.

message_id: &'a str

The message’s id.

channel: Option<&'a str>

The channel the run was started on.

considered: usize

How many workflows the run considers: its channel’s Active ones, before any rollout or condition is judged.

#[non_exhaustive]

WorkflowStarted

A workflow was selected: its condition admitted it, or it has none. Once per workflow, a loop’s included. A workflow that ends Ran with no judgment of its condition reached (a loop that enters no sweep, or a run stopped before the condition) gets it as it ends, before its WorkflowFinished.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

workflow: WorkflowIx

The workflow’s position in the program.

id: &'a str

The workflow’s id.

#[non_exhaustive]

TaskFinished

A call was recorded: once per call, a fan-out’s once per element it folds, and once with no element for a fan-out with nothing to call or cut short. A task its condition refused is not.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

info: &'a CallInfo<'a>

The call: its workflow, its task and the function’s registered name, its loop counter and its element.

status: Option<u16>

The status recorded; None for a Skip.

elapsed: Option<Duration>

How long the call ran, the recording not included.

#[non_exhaustive]

WorkflowFinished

A workflow that was selected ended. Its record says how, and how many sweeps it ran.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

record: &'a WorkflowRecord<'a>

What the workflow did.

elapsed: Option<Duration>

How long since its WorkflowStarted.

#[non_exhaustive]

RunFinished

The run ended, whatever its status.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

message_id: &'a str

The message’s id, as its RunStarted named it: what ties the end to the start when one observer sees runs overlap.

status: &'a RunStatus

How the run ended.

errors: usize

How many error records the message holds.

elapsed: Option<Duration>

How long the run took.

Trait Implementations

impl<'a> Debug for Event<'a>

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

Formats the value using the given formatter.