Struct iyes_progress::Progress

pub struct Progress {
    pub done: u32,
    pub total: u32,
}

Progress reported by a system

It indicates how much work that system has still left to do.

When the value of done reaches the value of total, the system is considered “ready”. When all systems in your state are “ready”, we will transition to the next state.

For your convenience, you can easily convert bools into this type. You can also convert Progress values into floats in the 0.0..1.0 range.

If you want your system to report some progress in a way that is counted separately and should not affect progress bars or other user-facing indicators, you can use HiddenProgress instead.

Fields

done: u32

Units of work completed during this execution of the system

total: u32

Total units of work expected

Trait Implementations

impl Add for Progress

type Output = Progress

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl AddAssign for Progress

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl ApplyProgress for Progress

fn apply_progress(self, total: &ProgressCounter)

Account the value into the total progress for this frame

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

Formats the value using the given formatter.

impl Default for Progress

fn default() -> Progress

Returns the “default value” for a type.

impl From<Progress> for f32

fn from(p: Progress) -> f32

Converts to this type from the input type.

impl From<Progress> for f64

fn from(p: Progress) -> f64

Converts to this type from the input type.

impl From<bool> for Progress

fn from(b: bool) -> Progress

Converts to this type from the input type.

impl Copy for Progress