Struct TaskUpdate 

pub struct TaskUpdate {
    pub total: Option<f64>,
    pub completed: Option<f64>,
    pub advance: Option<f64>,
    pub description: Option<String>,
    pub visible: Option<bool>,
    pub fields: Vec<(String, FormatValue)>,
    pub refresh: bool,
}

Changes for Progress::update; unset fields are left alone. Upstream’s keyword arguments to Progress.update.

Fields

total: Option<f64>

completed: Option<f64>

advance: Option<f64>

description: Option<String>

visible: Option<bool>

fields: Vec<(String, FormatValue)>

Custom fields to set (upstream **fields).

refresh: bool

Redraw a live display right after the update (upstream refresh=True).

Implementations

impl TaskUpdate

pub fn total(self, total: f64) -> Self

pub fn completed(self, completed: f64) -> Self

pub fn advance(self, advance: f64) -> Self

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

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

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

Redraw a LiveProgress right after this update (upstream refresh=True).

pub fn field( self, name: impl Into<String>, value: impl Into<FormatValue>, ) -> Self

Set a custom field (upstream update(task_id, **fields)).

Trait Implementations

impl Clone for TaskUpdate

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TaskUpdate

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

Formats the value using the given formatter.

impl Default for TaskUpdate

fn default() -> Self

Returns the “default value” for a type.