Struct GridProgress 

pub struct GridProgress { /* private fields */ }

Progress of work the grid waits for: a load, a reload, a recalculation.

Written with GridWriter::set_progress, in order with the data, and read from StoreSnapshot::progress.

Implementations

impl GridProgress

pub fn indeterminate() -> Self

Work of unknown length.

pub fn new(fraction: f32) -> Self

Work that is fraction done, clamped to 0.0..=1.0; NaN is indeterminate.

pub fn with_label(self, label: impl Into<Arc<str>>) -> Self

Sets the text that describes the work, e.g. “Loading trades”.

pub fn fraction(&self) -> Option<f32>

The done fraction in 0.0..=1.0, or None for work of unknown length.

pub fn label(&self) -> Option<&str>

The text that describes the work.

pub fn is_indeterminate(&self) -> bool

Returns true if the length of the work is unknown.

Trait Implementations

impl Clone for GridProgress

fn clone(&self) -> GridProgress

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GridProgress

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

Formats the value using the given formatter.

impl PartialEq for GridProgress

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

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

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 StructuralPartialEq for GridProgress