[][src]Struct coffee::load::Progress

pub struct Progress { /* fields omitted */ }

The progress of a Task.

Methods

impl Progress[src]

pub fn total_work(&self) -> u32[src]

Returns the total amount of work of the related Task.

pub fn completed_work(&self) -> u32[src]

Returns the amount of completed work of the related Task.

The returned value is guaranteed to be in [0, total_work].

pub fn percentage(&self) -> f32[src]

Returns the amount of progress of the related Task as a percentage.

You can use this value directly in your loading screen.

pub fn stage(&self) -> Option<&String>[src]

Returns the title of the current Task::stage, if there is one.

You can use this to provide additional feedback to users.

Trait Implementations

impl Debug for Progress[src]

impl Eq for Progress[src]

impl PartialEq<Progress> for Progress[src]

impl StructuralEq for Progress[src]

impl StructuralPartialEq for Progress[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> SetParameter for T

impl<SS, SP> SupersetOf<SS> for SP where
    SS: SubsetOf<SP>, 

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,