Struct ProgressCursor 

pub struct ProgressCursor { /* private fields */ }

The furthest progress reported for one request so far.

One per in-flight request, held on the in-flight entry, so it is dropped exactly when the request is — there is no table of stale cursors to age out.

Implementations

impl ProgressCursor

pub const fn new() -> Self

A cursor that has reported nothing.

pub fn advance(&mut self, update: &ProgressUpdate) -> bool

Records an update and says whether it should go on the wire.

false for an update that does not move the cursor forward. The first update always moves it, including one reporting 0.0, because a request that said “tell me about this” is owed at least one notification and a zero-valued first update is how a handler says “started”.

NaN is refused rather than compared. It would fail every ordering test — including the is_finite one a reader expects to find here — and so would wedge the cursor at whatever it last reached, silently suppressing every later update. A value that is not a number is not progress.

pub const fn furthest(&self) -> Option<f64>

The furthest value reported so far.

Trait Implementations

impl Clone for ProgressCursor

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ProgressCursor

impl Debug for ProgressCursor

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

Formats the value using the given formatter.

impl Default for ProgressCursor

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for ProgressCursor

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

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ProgressCursor