Struct Status 

pub struct Status<'a> { /* private fields */ }

Plain-text report to encode. None means absent, not “keep prior value”.

Implementations

impl<'a> Status<'a>

pub const fn new(state: State) -> Self

Begins a complete replacement for the root record.

pub const fn clear() -> Self

Removes the addressed subtree, or all records when no id is supplied.

pub const fn id(self, id: RecordId<'a>) -> Self

Addresses a validated child record.

pub const fn app(self, app: AppId<'a>) -> Self

Adds a validated application identifier; repeat it on every root update.

pub const fn title(self, title: &'a str) -> Self

Adds a single-line label, validated when sent.

pub const fn message(self, message: &'a str) -> Self

Adds a single-line message, validated when sent.

pub const fn kind(self, kind: Kind) -> Self

Adds the blocking reason. Sending this on another state is an error.

pub const fn progress(self, progress: Progress) -> Self

Adds a percentage. Sending this outside working/blocked is an error.

pub fn write_to<W: Write + ?Sized>(self, output: &mut W) -> Result<(), Error>

Encodes a complete report and writes it through the caller’s writer. This method does not flush the writer.

Errors

Returns a validation error before writing if text is invalid or fields are incompatible with the state. Returns an I/O error if writing fails; I/O failures can leave a partial frame, as with any write_all operation.

Trait Implementations

impl<'a> Clone for Status<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for Status<'a>

impl<'a> Debug for Status<'a>

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

Formats the value using the given formatter.