Progress

Struct Progress

pub struct Progress { /* private fields */ }

Expand description

Status update about a task progress.

Implementations§

impl Progress

pub fn indeterminate() -> Self

New indeterminate.

pub fn complete() -> Self

New completed.

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

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) -> Self

New with completed n of total.

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

Set the display message about the task status update.

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

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>) -> Self

Combine the factor completed fct with another factor.

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

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

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

Replace the fct value with a new factor.

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

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 duplicate 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

Formats the value using the given formatter. Read more

impl Display for Progress

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

Formats the value using the given formatter. Read more

impl From<&'static str> for Progress

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

Converts to this type from the input type.

impl From<(usize, usize)> for Progress

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

Converts to this type from the input type.

impl From<Factor> for Progress

fn from(completed: Factor) -> Self

Converts to this type from the input type.

impl From<FactorPercent> for Progress

fn from(completed: FactorPercent) -> Self

Converts to this type from the input type.

impl From<Metrics> for Progress

fn from(metrics: Metrics) -> Self

Converts to this type from the input type.

impl From<Metrics> for Progress

fn from(metrics: Metrics) -> Self

Converts to this type from the input type.

impl From<Progress> for Factor

fn from(status: Progress) -> Self

Converts to this type from the input type.

impl From<Progress> for FactorPercent

fn from(status: Progress) -> Self

Converts to this type from the input type.

impl From<Progress> for f32

fn from(status: Progress) -> Self

Converts to this type from the input type.

impl From<Txt> for Progress

fn from(indeterminate_message: Txt) -> Self

Converts to this type from the input type.

impl From<bool> for Progress

fn from(indeterminate_or_completed: bool) -> Self

Converts to this type from the input type.

impl From<f32> for Progress

fn from(completed: f32) -> Self

Converts to this type from the input type.

impl IntoVar<Factor> for Progress

fn into_var(self) -> Var<Factor>

impl IntoVar<FactorPercent> for Progress

fn into_var(self) -> Var<FactorPercent>

impl IntoVar<Progress> for &'static str

fn into_var(self) -> Var<Progress>

impl IntoVar<Progress> for (usize, usize)

fn into_var(self) -> Var<Progress>

impl IntoVar<Progress> for Factor

fn into_var(self) -> Var<Progress>

impl IntoVar<Progress> for FactorPercent

fn into_var(self) -> Var<Progress>

impl IntoVar<Progress> for Metrics

fn into_var(self) -> Var<Progress>

impl IntoVar<Progress> for Metrics

fn into_var(self) -> Var<Progress>

impl IntoVar<Progress> for Txt

fn into_var(self) -> Var<Progress>

impl IntoVar<Progress> for bool

fn into_var(self) -> Var<Progress>

impl IntoVar<Progress> for f32

fn into_var(self) -> Var<Progress>

impl IntoVar<f32> for Progress

fn into_var(self) -> Var<f32>

impl PartialEq for Progress

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

impl IntoValue<Factor> for Progress

impl IntoValue<FactorPercent> for Progress

impl IntoValue<Progress> for &'static str

impl IntoValue<Progress> for (usize, usize)

impl IntoValue<Progress> for Factor

impl IntoValue<Progress> for FactorPercent

impl IntoValue<Progress> for Metrics

impl IntoValue<Progress> for Metrics

impl IntoValue<Progress> for Txt

impl IntoValue<Progress> for bool

impl IntoValue<Progress> for f32

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> AnyVarValue for T
where T: Debug + PartialEq + Clone + Any + Send + Sync,

fn clone_boxed(&self) -> BoxAnyVarValue

Clone the value.

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

Gets if self and other are equal.

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

Swap value with other if both are of the same type.

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, dest: *mut u8)

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

Performs copy-assignment from self to dest. Read more

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

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

Checks if this value is equivalent to the given key. Read more

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> 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<U> 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

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

fn into_var(self) -> Var<T>

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Same for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T> ToTxt for T
where T: ToString,

fn to_txt(&self) -> Txt

Converts the given value to an owned Txt. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

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

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

impl<T> VarValue for T
where T: AnyVarValue + Clone + PartialEq,