Enum ProgressEvent 

#[non_exhaustive]
pub enum ProgressEvent {
    Started {
        id: ComponentId,
        total: Option<u64>,
        unit: ProgressUnit,
    },
    Progress {
        id: ComponentId,
        fetched: u64,
        total: Option<u64>,
    },
    Skipped {
        id: ComponentId,
    },
    Done {
        id: ComponentId,
        transferred: u64,
    },
    Message(String),
}

Events emitted during a pull or download operation.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Started

A new component (layer/object) has started being fetched.

Fields

id: ComponentId

Identifier for this component.

total: Option<u64>

Total amount to transfer (bytes or items depending on unit), if known.

unit: ProgressUnit

Unit of measurement for total and subsequent Progress events.

Progress

Progress update for a component.

Fields

id: ComponentId

Identifier for this component.

fetched: u64

Amount transferred so far (bytes or items depending on the Started unit).

total: Option<u64>

Total amount (bytes or items), if known.

Skipped

A component was skipped because it was already present.

This event may be emitted without a preceding ProgressEvent::Started when the component is determined to be cached before any download begins. Renderers must handle this case gracefully.

Fields

id: ComponentId

Identifier for the skipped component.

Done

A component completed successfully.

Fields

id: ComponentId

Identifier for this component.

transferred: u64

Amount actually transferred (bytes or items per the Started unit).

Message(String)

A human-readable status message (replaces progress-bar text lines).

Trait Implementations

impl Clone for ProgressEvent

fn clone(&self) -> ProgressEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProgressEvent

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

Formats the value using the given formatter.

impl PartialEq for ProgressEvent

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