Struct Report 

pub struct Report<T> {
    pub schema: u32,
    pub command: Command,
    pub captured_utc: Option<String>,
    pub polls: Option<u32>,
    pub elapsed_ms: Option<u64>,
    pub ok: bool,
    pub results: Vec<T>,
}

A command’s answer: the rows it produced, and whether they pass.

Generic over the row type rather than an enum of every command’s shape, so adding a command adds a row type instead of editing a type every existing consumer matches on.

Fields

schema: u32

command: Command

captured_utc: Option<String>

When the frames behind this answer were taken. Absent for the commands that do not capture — assert, and resolve without --relocate. Supplied by the caller; this crate has no clock.

polls: Option<u32>

How many times the screen was polled to reach this answer, and how long that took. Present only for commands that loop — wait — and provenance in the same sense captured_utc is: they describe how the answer was obtained, never what it is.

elapsed_ms is measured rather than derived. wait decides when to stop by counting polls, not by watching a clock, so the two do not imply each other: capture time is real and is not budgeted.

elapsed_ms: Option<u64>

ok: bool

The aggregate the exit code mirrors: 0 when true, 1 when false.

Each command computes this from its own rows, in its own module. What makes a command report failure is the most important line it has, and it belongs where a reader will look for it rather than in a trait implementation five files away.

results: Vec<T>

Implementations

impl<T> Report<T>

pub fn captured( command: Command, captured_utc: String, ok: bool, results: Vec<T>, ) -> Self

A document from a command that captured.

pub fn offline(command: Command, ok: bool, results: Vec<T>) -> Self

A document from a command that answered from the session alone.

pub fn polled(self, polls: u32, elapsed_ms: u64) -> Self

Record how much polling produced this answer. Only wait loops, so only wait calls this.

Trait Implementations

impl<T: Clone> Clone for Report<T>

fn clone(&self) -> Report<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Report<T>

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

Formats the value using the given formatter.

impl<T: PartialEq> PartialEq for Report<T>

fn eq(&self, other: &Report<T>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<T> Serialize for Report<T>

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: PartialEq> StructuralPartialEq for Report<T>