Enum EventKind 

#[non_exhaustive]
pub enum EventKind {
    State {
        from: RunState,
        to: RunState,
    },
    Step {
        step: String,
        state: StepState,
        note: Option<String>,
    },
    Log {
        step: String,
        stream: Stream,
        line: String,
    },
    Ready {
        condition: String,
        state: ReadyState,
        detail: String,
    },
    Output {
        name: String,
        role: OutputRole,
        value: Option<String>,
        sensitive: bool,
    },
    Check {
        runner: String,
        from: String,
        name: String,
        ok: bool,
        detail: String,
    },
    Warning {
        code: WarningCode,
        message: String,
    },
    Result {
        ok: bool,
        data: Value,
    },
    Error {
        code: ErrorCode,
        message: String,
        step: Option<String>,
    },
}

What happened.

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.

State

The run moved from one state to another.

Fields

from: RunState

Before.

to: RunState

After.

Step

A step started, finished, failed or was skipped.

Fields

step: String

The step’s id.

state: StepState

Where it stands.

note: Option<String>

The manifest’s line for it, when it starts.

Log

A line a step’s tool printed.

Fields

step: String

The step’s id.

stream: Stream

Which output.

line: String

The line, without its line break.

Ready

A ready condition was checked.

Fields

condition: String

The condition (step_ok up).

state: ReadyState

Where it stands.

detail: String

What was seen.

Output

An output’s value, once the run is up.

Fields

name: String

The output’s name.

role: OutputRole

What it is for.

value: Option<String>

Its value (*** when sensitive), or null when it can’t be read.

sensitive: bool

Whether the value is sensitive.

Check

One check’s result.

Fields

runner: String

The check runner’s id.

from: String

Where it ran from.

name: String

The check’s name.

ok: bool

Whether it passed.

detail: String

Why it failed (empty when it passed).

Warning

Something the embedder may show, that didn’t fail the operation.

Fields

code: WarningCode

What kind.

message: String

The text.

Result

The operation’s outcome, when it ran to its end.

Fields

ok: bool

Whether it reached its goal (false: a check failed).

data: Value

What it found or produced.

Error

Why the operation failed.

Fields

code: ErrorCode

The stable code.

message: String

The message.

step: Option<String>

The step that failed, when one did.

Trait Implementations

impl Clone for EventKind

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 EventKind

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EventKind

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for EventKind

fn schema_name() -> Cow<'static, str>

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 inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for EventKind

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for EventKind

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for EventKind