Struct TaskProgress 

pub struct TaskProgress {
    pub fraction: Option<f32>,
    pub steps: Option<(u32, u32)>,
    pub bytes: Option<(u64, u64)>,
    pub items: Option<(u32, u32)>,
    pub eta_secs: Option<u64>,
    pub message: Option<String>,
}

Progress information for a task.

Fields

fraction: Option<f32>

Progress as fraction (0.0 - 1.0), None if indeterminate

steps: Option<(u32, u32)>

Current step / total steps

bytes: Option<(u64, u64)>

Bytes processed / total bytes

items: Option<(u32, u32)>

Items processed / total items

eta_secs: Option<u64>

ETA in seconds

message: Option<String>

Current status message

Implementations

impl TaskProgress

pub fn indeterminate() -> Self

Create indeterminate progress.

pub fn fraction(f: f32) -> Self

Create progress from a fraction.

pub fn steps(current: u32, total: u32) -> Self

Create progress from steps.

pub fn with_message(self, msg: impl Into<String>) -> Self

Add a message to the progress.

pub fn with_eta(self, secs: u64) -> Self

Add ETA to the progress.

Trait Implementations

impl Clone for TaskProgress

fn clone(&self) -> TaskProgress

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TaskProgress

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TaskProgress

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for TaskProgress

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.