Struct ordered_stream::FromStream

pub struct FromStream<S, F, Ordering> { /* private fields */ }

An OrderedStream wrapper around a Stream.

This caches the last-used ordering point returned by the stream and uses it to produce NoneBefore results. This makes it suitable for using to adapt streams that are filtered or mapped before joining. It still relies on the original stream producing a later-ordered element to allow other streams to progress, however.

Implementations

impl<S, F, Ordering> FromStream<S, F, Ordering>where
    S: Stream,
    Ordering: Ord + Clone,

pub fn new<Data>(stream: S, split_item: F) -> Selfwhere
    F: FnMut(S::Item) -> (Ordering, Data),

Create a new OrderedStream by applying a split_item closure to each element produced by the original stream.

pub fn with_ordering(
    stream: S,
    get_ordering: F
) -> FromStream<S, impl FnMut(S::Item) -> (Ordering, S::Item), Ordering>where
    F: FnMut(&S::Item) -> Ordering,

Helper function to simplify the creation of a stream when you have a get_ordering function.

Trait Implementations

impl<S: Debug, F: Debug, Ordering: Debug> Debug for FromStream<S, F, Ordering>

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

Formats the value using the given formatter.

impl<S, F, Ordering, Data> FusedOrderedStream for FromStream<S, F, Ordering>where
    S: FusedStream,
    F: FnMut(S::Item) -> (Ordering, Data),
    Ordering: Ord + Clone,

fn is_terminated(&self) -> bool

Returns true if the stream should no longer be polled.

impl<S, F, Ordering, Data> OrderedStream for FromStream<S, F, Ordering>where
    S: Stream,
    F: FnMut(S::Item) -> (Ordering, Data),
    Ordering: Ord + Clone,

type Data = Data

The unordered data carried by this stream

type Ordering = Ordering

The type ordered by this stream.

fn poll_next_before(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    before: Option<&Self::Ordering>
) -> Poll<PollResult<Ordering, Data>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if needed, and returning NoneBefore if it is known that the stream will not produce any more values ordered before the given point.

fn position_hint(&self) -> Option<MaybeBorrowed<'_, Self::Ordering>>

The minimum value of the ordering for any future items.

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

Returns the bounds on the remaining length of the stream.

impl<'__pin, S, F, Ordering> Unpin for FromStream<S, F, Ordering>where
    __Origin<'__pin, S, F, Ordering>: Unpin,