Struct ordered_stream::FromStream
source · pub struct FromStream<S, F, Ordering> { /* private fields */ }
Expand description
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§
source§impl<S, F, Ordering> FromStream<S, F, Ordering>
impl<S, F, Ordering> FromStream<S, F, Ordering>
sourcepub fn new<Data>(stream: S, split_item: F) -> Self
pub fn new<Data>(stream: S, split_item: F) -> Self
Create a new OrderedStream
by applying a split_item
closure to each element
produced by the original stream.
sourcepub fn with_ordering(
stream: S,
get_ordering: F,
) -> FromStream<S, impl FnMut(S::Item) -> (Ordering, S::Item), Ordering>
pub fn with_ordering( stream: S, get_ordering: F, ) -> FromStream<S, impl FnMut(S::Item) -> (Ordering, S::Item), Ordering>
Helper function to simplify the creation of a stream when you have a get_ordering function.
Trait Implementations§
source§impl<S, F, Ordering, Data> FusedOrderedStream for FromStream<S, F, Ordering>
impl<S, F, Ordering, Data> FusedOrderedStream for FromStream<S, F, Ordering>
source§fn is_terminated(&self) -> bool
fn is_terminated(&self) -> bool
Returns
true
if the stream should no longer be polled.source§impl<S, F, Ordering, Data> OrderedStream for FromStream<S, F, Ordering>
impl<S, F, Ordering, Data> OrderedStream for FromStream<S, F, Ordering>
source§fn poll_next_before(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
before: Option<&Self::Ordering>,
) -> Poll<PollResult<Ordering, Data>>
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. Read moresource§fn position_hint(&self) -> Option<MaybeBorrowed<'_, Self::Ordering>>
fn position_hint(&self) -> Option<MaybeBorrowed<'_, Self::Ordering>>
The minimum value of the ordering for any future items. Read more
impl<'__pin, S, F, Ordering> Unpin for FromStream<S, F, Ordering>where
PinnedFieldsOf<__Origin<'__pin, S, F, Ordering>>: Unpin,
Auto Trait Implementations§
impl<S, F, Ordering> Freeze for FromStream<S, F, Ordering>
impl<S, F, Ordering> RefUnwindSafe for FromStream<S, F, Ordering>
impl<S, F, Ordering> Send for FromStream<S, F, Ordering>
impl<S, F, Ordering> Sync for FromStream<S, F, Ordering>
impl<S, F, Ordering> UnwindSafe for FromStream<S, F, Ordering>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> OrderedStreamExt for Twhere
T: OrderedStream + ?Sized,
impl<T> OrderedStreamExt for Twhere
T: OrderedStream + ?Sized,
source§fn map_item<F, R>(self, f: F) -> MapItem<Self, F>
fn map_item<F, R>(self, f: F) -> MapItem<Self, F>
Apply a closure to the items that has access to the ordering data.
source§fn map_ordering<NewOrdering, NewData, MapInto, MapFrom>(
self,
map_into: MapInto,
map_from: MapFrom,
) -> MapOrdering<Self, MapInto, MapFrom>where
Self: Sized,
MapInto: FnMut(Self::Ordering, Self::Data) -> (NewOrdering, NewData),
MapFrom: FnMut(&NewOrdering) -> Option<Self::Ordering>,
NewOrdering: Ord,
fn map_ordering<NewOrdering, NewData, MapInto, MapFrom>(
self,
map_into: MapInto,
map_from: MapFrom,
) -> MapOrdering<Self, MapInto, MapFrom>where
Self: Sized,
MapInto: FnMut(Self::Ordering, Self::Data) -> (NewOrdering, NewData),
MapFrom: FnMut(&NewOrdering) -> Option<Self::Ordering>,
NewOrdering: Ord,
Apply a closure to the items that can change the type of the ordering value. Read more
fn filter<F>(self, filter: F) -> Filter<Self, F>
fn filter_map<F, R>(self, filter: F) -> FilterMap<Self, F>
source§fn into_stream(self) -> IntoStream<Self>where
Self: Sized,
fn into_stream(self) -> IntoStream<Self>where
Self: Sized,
Convert this into a
Stream
, discarding the ordering information.source§fn into_tuple_stream(self) -> IntoTupleStream<Self>where
Self: Sized,
fn into_tuple_stream(self) -> IntoTupleStream<Self>where
Self: Sized,
Convert this into a
Stream
, keeping the ordering objects.source§fn into_ordering(self) -> IntoOrdering<Self>where
Self: Sized,
fn into_ordering(self) -> IntoOrdering<Self>where
Self: Sized,
Convert this into a
Stream
, keeping only the ordering objects.source§fn next_before<'a>(
&'a mut self,
before: Option<&'a Self::Ordering>,
) -> NextBefore<'a, Self> ⓘwhere
Self: Unpin,
fn next_before<'a>(
&'a mut self,
before: Option<&'a Self::Ordering>,
) -> NextBefore<'a, Self> ⓘwhere
Self: Unpin,
Return a
PollResult
corresponding to the next item in the stream.