Struct ReportBuilder 

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

Builds a Report from unvalidated program input. See Report::builder.

Implementations

impl<'a> ReportBuilder<'a>

pub fn id(self, id: &'a str) -> ReportBuilder<'a>

Addresses a child record instead of the root.

pub fn kind(self, kind: Kind) -> ReportBuilder<'a>

What a blocked program needs. Dropped unless the state is blocked.

pub fn progress(self, progress: u8) -> ReportBuilder<'a>

0..=100. Dropped unless the state is working or blocked.

pub fn app(self, app: &'a str) -> ReportBuilder<'a>

Program identifier, [A-Za-z0-9_.+-]{1,32}.

pub fn title(self, title: &'a str) -> ReportBuilder<'a>

Short label, at most 192 bytes, no control characters. Empty text is the same as no title.

pub fn msg(self, msg: &'a str) -> ReportBuilder<'a>

One line of text, at most 2048 bytes, no control characters. Empty text is the same as no msg. Pass untrusted text through sanitize (feature alloc) first.

pub fn build(self) -> Result<Report<'a>, Error>

Validates everything a terminal would check, so a built report is never discarded by a conforming terminal.

Trait Implementations

impl<'a> Clone for ReportBuilder<'a>

fn clone(&self) -> ReportBuilder<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for ReportBuilder<'a>

impl<'a> Debug for ReportBuilder<'a>

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

Formats the value using the given formatter.