Enum State

pub enum State {
    InProgress {
        len: Option<u64>,
        pos: u64,
        bytes: bool,
        remaining: f32,
    },
    Completed {
        duration: f32,
    },
    Cancelled,
}

The state of the progress.

This structure is serialisable with the serde feature.

Variants

InProgress

The report is in progress.

Fields

len: Option<u64>

Optional length, if empty, the report is indeterminate.

pos: u64

Current report position.

bytes: bool

The len/pos should be formatted in bytes.

remaining: f32

Seconds remaining.

Completed

The progress reporter is finished.

This occurs when Tx::finish is called.

Fields

duration: f32

Duration, in seconds.

Cancelled

The progress was cancelled.

Trait Implementations

impl Clone for State

fn clone(&self) -> State

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for State

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

Formats the value using the given formatter.

impl Default for State

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for State

fn eq(&self, other: &State) -> 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 State

impl StructuralPartialEq for State