Struct ordered_stream::FromStreamDirect

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

An OrderedStream wrapper around a Stream.

This does not use any future or past knowledge of elements, and so is suitable if the stream rarely or never blocks. Prefer using FromStream if you plan to filter or join this stream and want other streams to be able to make progress while this one blocks.

Implementations

impl<S, F> FromStreamDirect<S, F>

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

where S: Stream, F: FnMut(S::Item) -> (Ordering, Data), Ordering: Ord,

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

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

where S: Stream, F: FnMut(&S::Item) -> Ordering, Ordering: Ord,

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

Trait Implementations

impl<S: Debug, F: Debug> Debug for FromStreamDirect<S, F>

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

Formats the value using the given formatter.

impl<S, F, Ordering, Data> FusedOrderedStream for FromStreamDirect<S, F>

where S: FusedStream, F: FnMut(S::Item) -> (Ordering, Data), Ordering: Ord,

fn is_terminated(&self) -> bool

Returns true if the stream should no longer be polled.

impl<S, F, Ordering, Data> OrderedStream for FromStreamDirect<S, F>

where S: Stream, F: FnMut(S::Item) -> (Ordering, Data), Ordering: Ord,

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<'_>, _: Option<&Self::Ordering>, ) -> Poll<PollResult<Self::Ordering, Self::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 size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.

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

The minimum value of the ordering for any future items.

impl<'__pin, S, F> Unpin for FromStreamDirect<S, F>

where PinnedFieldsOf<__Origin<'__pin, S, F>>: Unpin,