Enum Event 

pub enum Event {
    Run {
        utc: String,
        session: String,
        executed: bool,
    },
    Step {
        utc: String,
        index: usize,
        summary: String,
        outcome: StepOutcome,
        points: Vec<ResolvedPoint>,
        elapsed_ms: u64,
        detail: Option<String>,
    },
}

One line of the log.

Variants

Run

Opens a run. Everything after it, until the next run, belongs to this one.

Fields

utc: String

RFC 3339, supplied by the caller — this crate holds no clock.

session: String

executed: bool

False for a resolved-but-not-performed run, so a reader can never mistake a plan for something that happened.

Step

One step, after it finished.

Fields

utc: String

index: usize

summary: String

The redacted label — never the step itself. See the module docs.

outcome: StepOutcome

points: Vec<ResolvedPoint>

Where the input actually went, after space conversion. The saved coordinate is in the session; this is the one that was sent, and the only one worth having when a run went wrong.

elapsed_ms: u64

detail: Option<String>

Implementations

impl Event

pub fn run(utc: String, session: String, executed: bool) -> Self

Open a run.

pub fn step(utc: String, report: &StepReport) -> Self

Record a finished step.

Takes the report rather than the step, which is what makes typed text unreachable from here.

pub fn line(&self) -> String

The line to append, newline included.

Serialization of these types cannot fail — every field is a string, a number, a bool or a Vec of those — so a failure here would be a bug in this module rather than bad input, and the record says so instead of vanishing.

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Event

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Event

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Event

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Event

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 Event