Struct Sequencer 

pub struct Sequencer<S: Stream> {
    inner: S,
    timer: Sleep,
    buffer: BinaryHeap<Reverse<S::Item>>,
    next_id: FrameId,
    last_emitted: Instant,
    max_wait: Duration,
    state: State,
}

Sequencer is an adaptor for streams, that yield elements that have a natural ordering and can be compared with FrameId and puts them in the correct sequence starting with FrameId equal to 1.

Sequencer internally maintains a FrameId to be yielded next, polls the underlying stream and yields elements only when they match the next FrameId to be yielded, incrementing the value on each yield.

The Sequencer takes to arguments: max_wait and capacity:

The max_wait indicates the maximum amount of time to wait for a certain FrameId to be yielded from the underlying stream. If this does not happen, the Segmenter yields an error, indicating that the given frame was discarded.

The capacity parameter sets the maximum number of buffered elements inside the Sequencer. If this value is reached, the Sequencer will stop polling the underlying stream, waiting for the next element to expire.

By definition, Sequencer is a fallible stream, yielding either Ok(Item), Err(SessionError::FrameDiscarded) or Ok(None) when the underlying stream is closed and no more elements can be yielded.

Use SequencerExt methods to turn a stream into a sequenced stream.

Fields

inner: S

timer: Sleep

buffer: BinaryHeap<Reverse<S::Item>>

next_id: FrameId

last_emitted: Instant

max_wait: Duration

state: State

Implementations

impl<S: Stream> Sequencer<S>

pub(crate) fn project<'pin>( self: Pin<&'pin mut Self>, ) -> __SequencerProjection<'pin, S>

pub(crate) fn project_ref<'pin>( self: Pin<&'pin Self>, ) -> __SequencerProjectionRef<'pin, S>

impl<S> Sequencer<S>

where S: Stream, S::Item: Ord + PartialOrd<FrameId>,

fn new(inner: S, max_wait: Duration, capacity: usize) -> Self

Creates a new instance, wrapping the given inner Segment sink.

The frame_size value will be clamped into the `[C, (C - SessionMessage::SEGMENT_OVERHEAD) * SeqIndicator::MAX

• 1]` interval.

Trait Implementations

impl<S> Stream for Sequencer<S>

where S: Stream, S::Item: Ord + PartialOrd<FrameId>,

type Item = Result<<S as Stream>::Item, SessionError>

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.

impl<'pin, S: Stream> Unpin for Sequencer<S>

where PinnedFieldsOf<__Sequencer<'pin, S>>: Unpin,