Struct Tx

pub struct Tx { /* private fields */ }

The progress reporter transmitter.

Implementations

impl Tx

pub fn id(&self) -> Id

The distinct ID.

pub fn label<L: Into<String>>(self, label: L) -> Self

Set the label/name of the report.

howudoin::new().label("Report A");

pub fn set_len<L: Into<Option<u64>>>(self, len: L) -> Self

Set an upper bound on the progress.

If the progress is indeterminate, None can be specified.

howudoin::new().set_len(100);

pub fn fmt_as_bytes(self, fmt_as_bytes: bool) -> Self

Flag to format the position as bytes.

pub fn desc<D: Into<String>>(&self, desc: D) -> &Self

Set the report message.

let a = howudoin::new();
a.desc("processing");

pub fn inc(&self) -> &Self

Increment the report 1 position.

let a = howudoin::new();
a.inc();

pub fn inc_by<P: Into<u64>>(&self, delta: P) -> &Self

Increment the report position by delta.

let a = howudoin::new();
a.inc_by(5_u8);

pub fn set_pos<P: Into<u64>>(&self, pos: P) -> &Self

Set the report position.

let a = howudoin::new();
a.set_pos(5_u8);

pub fn add_err<M: Into<String>>(&self, msg: M) -> &Self

Add an error message.

let a = howudoin::new();
a.add_err("fail!");

pub fn add_warn<M: Into<String>>(&self, msg: M) -> &Self

Add an warning message.

let a = howudoin::new();
a.add_warn("careful...");

pub fn add_info<M: Into<String>>(&self, msg: M) -> &Self

Add an information message.

let a = howudoin::new();
a.add_info("hello");

pub fn add_accum<M: Into<String>>(&self, severity: Severity, msg: M) -> &Self

Add an accumulation message.

These messages are accumulated against a progress report, and consumers can display them for additional information.

pub fn cancelled(&self) -> bool

Check if the consumer loop has been flagged for cancellation.

It is up to the producer to decide what to do if cancellation is detected.

pub fn finish(self)

Mark this report as finished but should be kept displayed.

pub fn close(self)

Mark this report as finished and should be removed from display.

Trait Implementations

impl Clone for Tx

fn clone(&self) -> Tx

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq for Tx

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Tx

impl Eq for Tx

impl StructuralPartialEq for Tx