Skip to main content

Progress

Struct Progress 

Source
pub struct Progress { /* private fields */ }
Expand description

Counter shared between a reference algorithm (which bumps it) and a caller (which polls it for streaming progression).

Implementations§

Source§

impl Progress

Source

pub fn new() -> Self

Empty progress with total = 0. The reference algorithm will set the real total via Self::set_total once it knows the problem shape.

Source

pub fn with_total(total: u64) -> Self

Pre-declared total: caller already knows the count and just wants to poll. References still call Self::set_total on entry, which is a no-op when the value matches.

Source

pub fn set_total(&self, total: u64)

Declare the total number of output writes. Called by the reference algorithm at entry, before the first Self::bump.

Source

pub fn bump(&self)

Increment the counter by one output write.

Source

pub fn bump_by(&self, n: u64)

Increment the counter by n output writes — useful when a reference writes a contiguous run of outputs in one inner loop.

Source

pub fn total(&self) -> u64

Source

pub fn current(&self) -> u64

Source

pub fn fraction(&self) -> f64

current / total clamped to [0.0, 1.0]. Returns 0.0 when total is zero (reference hasn’t started or declared its total yet).

Trait Implementations§

Source§

impl Debug for Progress

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Progress

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> IntoComptime for T

Source§

fn comptime(self) -> Self

Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,