Enum ExecutionEvent 

pub enum ExecutionEvent {
    RunStarted {
        entries: Vec<(String, String)>,
        steps: Vec<StepInfo>,
    },
    StepStarted(StepInfo),
    StepCompleted(StepInfo),
    StepFailed {
        step: StepInfo,
        exit_code: u32,
        interrupted: bool,
    },
    StepSkipped(StepInfo),
    Output {
        offset: u64,
        bytes: Vec<u8>,
    },
    Progress {
        ended: usize,
        total: usize,
    },
    Warning(String),
    Completed(Finished),
    Interrupted(Finished),
}

Something that happened in a run.

Variants

RunStarted

Always the first event: the entries and the steps, in order.

Fields

entries: Vec<(String, String)>

steps: Vec<StepInfo>

StepStarted(StepInfo)

StepCompleted(StepInfo)

StepFailed

The step ended with a non-zero status; interrupted when a signal ended it, which also ends the run.

Fields

step: StepInfo

exit_code: u32

interrupted: bool

StepSkipped(StepInfo)

Not run, because a step it needs did not finish.

Output

Terminal output: the transcript’s bytes from offset on, exactly as the program wrote them, escape sequences included.

Fields

offset: u64

bytes: Vec<u8>

Progress

After each step ends, however it ended: how many have, of all.

Fields

ended: usize

total: usize

Warning(String)

Something the user should know that does not stop the run.

Completed(Finished)

The run ended by itself: it succeeded, failed or could not start. The checks of the steps that finished are done.

Interrupted(Finished)

The run was stopped, by request or by a signal; nothing is checked.

Trait Implementations

impl Clone for ExecutionEvent

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExecutionEvent

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

Formats the value using the given formatter.

impl Eq for ExecutionEvent

impl PartialEq for ExecutionEvent

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ExecutionEvent

The JSON form documented in docs/EVENTS.md: an object whose event names the kind, in snake case.

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ExecutionEvent