Struct Progress

pub struct Progress { /* private fields */ }

Status update about a task progress.

Implementations

impl Progress

pub fn indeterminate() -> Progress

New indeterminate.

pub fn complete() -> Progress

New completed.

pub fn from_fct(factor: impl Into<Factor>) -> Progress

New with a factor of completion.

The factor must be in the 0..=1 range, with a rounding error of 0.001, values outside this range are converted to indeterminate.

pub fn from_n_of(n: usize, total: usize) -> Progress

New with completed n of total.

pub fn with_msg(self, msg: impl Into<Txt>) -> Progress

Set the display message about the task status update.

pub fn with_meta_mut( self, meta: impl FnOnce(StateMapMut<'_, Progress>), ) -> Progress

Set custom status metadata for writing.

Note that metadata is shared between all clones of self.

pub fn and_fct(self, factor: impl Into<Factor>) -> Progress

Combine the factor completed fct with another factor.

pub fn and_n_of(self, n: usize, total: usize) -> Progress

Combine the factor completed fct with another factor computed from n of total.

pub fn with_fct(self, factor: impl Into<Factor>) -> Progress

Replace the fct value with a new factor.

pub fn with_n_of(self, n: usize, total: usize) -> Progress

Replace the fct value with a new factor computed from n of total.

pub fn fct(&self) -> Factor

Factor completed.

Is -1.fct() for indeterminate, otherwise is a value in the 0..=1 range, 1.fct() indicates task completion.

pub fn is_indeterminate(&self) -> bool

Factor of completion cannot be known.

pub fn is_complete(&self) -> bool

Task has completed.

pub fn msg(&self) -> Txt

Display text about the task status update.

pub fn with_meta<T>( &self, visitor: impl FnOnce(StateMapRef<'_, Progress>) -> T, ) -> T

Borrow the custom status metadata for reading.

Trait Implementations

impl Clone for Progress

fn clone(&self) -> Progress

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Progress

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

Formats the value using the given formatter.

impl Display for Progress

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

Formats the value using the given formatter.

impl From<&'static str> for Progress

fn from(indeterminate_message: &'static str) -> Progress

Converts to this type from the input type.

impl From<(usize, usize)> for Progress

fn from(n_total: (usize, usize)) -> Progress

Converts to this type from the input type.

impl From<Factor> for Progress

fn from(completed: Factor) -> Progress

Converts to this type from the input type.

impl From<FactorPercent> for Progress

fn from(completed: FactorPercent) -> Progress

Converts to this type from the input type.

impl From<Metrics> for Progress

fn from(metrics: Metrics) -> Progress

Converts to this type from the input type.

impl From<Txt> for Progress

fn from(indeterminate_message: Txt) -> Progress

Converts to this type from the input type.

impl From<bool> for Progress

fn from(indeterminate_or_completed: bool) -> Progress

Converts to this type from the input type.

impl From<f32> for Progress

fn from(completed: f32) -> Progress

Converts to this type from the input type.

impl IntoVar<Factor> for Progress

type Var = LocalVar<Factor>

Variable type that will wrap the T value.

fn into_var(self) -> <Progress as IntoVar<Factor>>::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<FactorPercent> for Progress

type Var = LocalVar<FactorPercent>

Variable type that will wrap the T value.

fn into_var(self) -> <Progress as IntoVar<FactorPercent>>::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<Progress> for &'static str

type Var = LocalVar<Progress>

Variable type that will wrap the T value.

fn into_var(self) -> <&'static str as IntoVar<Progress>>::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl IntoVar<f32> for Progress

type Var = LocalVar<f32>

Variable type that will wrap the T value.

fn into_var(self) -> <Progress as IntoVar<f32>>::Var

Converts the source value into a var.

fn into_boxed_var(self) -> Box<dyn VarBoxed<T>>

where Self: Sized,

Converts into BoxedVar<T>.

impl PartialEq for Progress

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

impl IntoValue<Factor> for Progress

impl IntoValue<FactorPercent> for Progress

impl IntoValue<Progress> for &'static str

impl IntoValue<f32> for Progress