Struct zng :: task :: Progress Copy item path

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. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl Debug for Progress

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

Formats the value using the given formatter. Read more

impl Display for Progress

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

Formats the value using the given formatter. Read more

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<Metrics> for Progress

fn from(metrics: Metrics) -> Progress

Converts to this type from the input type.

impl From<Progress> for Factor

fn from(status: Progress) -> Factor

Converts to this type from the input type.

impl From<Progress> for FactorPercent

fn from(status: Progress) -> FactorPercent

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. Read more

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>. Read more

impl IntoVar<FactorPercent> for Progress

type Var = LocalVar<FactorPercent>

Variable type that will wrap the T value. Read more

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>. Read more

impl IntoVar<Progress> for &'static str

type Var = LocalVar<Progress>

Variable type that will wrap the T value. Read more

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>. Read more

impl IntoVar<Progress> for (usize, usize)

type Var = LocalVar<Progress>

Variable type that will wrap the T value. Read more

fn into_var(self) -> <(usize, usize) 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>. Read more

impl IntoVar<Progress> for Factor

type Var = LocalVar<Progress>

Variable type that will wrap the T value. Read more

fn into_var(self) -> <Factor 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>. Read more

impl IntoVar<Progress> for FactorPercent

type Var = LocalVar<Progress>

Variable type that will wrap the T value. Read more

fn into_var(self) -> <FactorPercent 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>. Read more

impl IntoVar<Progress> for Metrics

type Var = LocalVar<Progress>

Variable type that will wrap the T value. Read more

fn into_var(self) -> <Metrics 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>. Read more

impl IntoVar<Progress> for Metrics

type Var = LocalVar<Progress>

Variable type that will wrap the T value. Read more

fn into_var(self) -> <Metrics 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>. Read more

impl IntoVar<Progress> for Txt

type Var = LocalVar<Progress>

Variable type that will wrap the T value. Read more

fn into_var(self) -> <Txt 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>. Read more

impl IntoVar<Progress> for bool

type Var = LocalVar<Progress>

Variable type that will wrap the T value. Read more

fn into_var(self) -> <bool 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>. Read more

impl IntoVar<Progress> for f32

type Var = LocalVar<Progress>

Variable type that will wrap the T value. Read more

fn into_var(self) -> <f32 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>. Read more

impl IntoVar<f32> for Progress

type Var = LocalVar<f32>

Variable type that will wrap the T value. Read more

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>. Read more

impl PartialEq for Progress

fn eq(&self, other: &Progress) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 · source§

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 IntoValue<f32> for Progress

Auto Trait Implementations§

impl Freeze for Progress

impl !RefUnwindSafe for Progress

impl Send for Progress

impl Sync for Progress

impl Unpin for Progress

impl !UnwindSafe for Progress

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> AnyEq for T
where T: Any + PartialEq,

fn equals(&self, other: &(dyn Any + 'static)) -> bool

fn as_any(&self) -> &(dyn Any + 'static)

impl<T> AnyVarValue for T
where T: VarValue,

fn as_any(&self) -> &(dyn Any + 'static)

Access to dyn Any methods.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Access to mut dyn Any methods.

fn clone_boxed(&self) -> Box<dyn AnyVarValue>

Clone the value.

fn clone_boxed_var(&self) -> Box<dyn AnyVar>

Clone the value into a new boxed LocalVar<Self>.

fn into_any(self: Box<T>) -> Box<dyn Any>

Access to Box<dyn Any> methods.

fn eq_any(&self, other: &(dyn AnyVarValue + 'static)) -> bool

Gets if self equals other.

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dst. Read more

impl<T> DataNoteValue for T
where T: Debug + Display + Send + Sync + Any + 'static,

fn as_any(&self) -> &(dyn Any + 'static)

/// Access to dyn Any methods.

impl<T> Downcast for T
where T: Any,

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.

impl<T> DowncastSync for T
where T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FsChangeNote for T
where T: Debug + Any + Send + Sync,

fn as_any(&self) -> &(dyn Any + 'static)

Access any.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more