Struct ProgressSink 

pub struct ProgressSink(/* private fields */);

An output seen only as a place to pass progress on, for cursors over a contract. A cursor passes the progress it meets inside a frame on through it, held back to what the decoder has read through the cursor and not reported yet: what it consumed since it last took the provenance (consumed()), and what it says it still holds (ProgressSink::hold) when it took provenance early for an event still to come. Made by Outbox::progress_sink; clones share their state.

Implementations

impl ProgressSink

pub fn progress(&self, tick: Tick) -> impl Future<Output = ()>

Passes Progress(tick) on, waiting for budget and for room like Outbox::progress; a tick at or before one already passed on is not sent again.

pub fn forwarded(&self) -> Option<Tick>

The latest tick passed on through this sink.

pub fn hold(&self, from: Option<Tick>)

Tells from which tick on the decoder still holds items it read through a cursor and has not reported — provenance it took early for an event still to come, such as a batch being filled — so that progress met inside a frame is held back to there; None once nothing is held. A decoder that takes provenance only when it emits never needs this.

pub fn held(&self) -> Option<Tick>

From where the decoder says it still holds items; see ProgressSink::hold.

Trait Implementations

impl Clone for ProgressSink

fn clone(&self) -> ProgressSink

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProgressSink

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

Formats the value using the given formatter.