Struct ordered_stream::Join

source ·
pub struct Join<A, B>
where A: OrderedStream, B: OrderedStream<Data = A::Data, Ordering = A::Ordering>,
{ /* private fields */ }
Expand description

A stream for the join function.

Implementations§

source§

impl<A, B> Join<A, B>
where A: OrderedStream, B: OrderedStream<Data = A::Data, Ordering = A::Ordering>,

source

pub fn into_inner(self) -> (A, B, Option<(A::Data, A::Ordering)>)

Split into the source streams.

This method returns the source streams along with any buffered item and its ordering.

source

pub fn stream_a(self: Pin<&mut Self>) -> Pin<&mut A>

Provide direct access to the underlying stream.

This may be useful if the stream provides APIs beyond OrderedStream. Note that the join itself may be buffering an item from this stream, so you should consult Self::peek_buffered and, if needed, Self::take_buffered before polling it directly.

source

pub fn stream_b(self: Pin<&mut Self>) -> Pin<&mut B>

Provide direct access to the underlying stream.

This may be useful if the stream provides APIs beyond OrderedStream. Note that the join itself may be buffering an item from this stream, so you should consult Self::peek_buffered and, if needed, Self::take_buffered before polling it directly.

source

pub fn peek_buffered( self: Pin<&mut Self>, ) -> (Option<(&mut A::Data, &A::Ordering)>, Option<(&mut B::Data, &B::Ordering)>)

Allow access to the buffered item, if any.

At most one of the two sides will be Some. The returned item is a candidate for being the next item returned by the joined stream, but it could not be returned by the most recent OrderedStream::poll_next_before call.

source

pub fn take_buffered(self: Pin<&mut Self>) -> Option<(A::Data, A::Ordering)>

Remove the buffered item, if one is present.

This does not poll either underlying stream. See Self::peek_buffered for details on why buffering exists.

Trait Implementations§

source§

impl<A, B> Debug for Join<A, B>
where A: OrderedStream + Debug, B: OrderedStream<Data = A::Data, Ordering = A::Ordering> + Debug, A::Data: Debug, B::Data: Debug, A::Ordering: Debug,

source§

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

Formats the value using the given formatter. Read more
source§

impl<A, B> FusedOrderedStream for Join<A, B>
where A: OrderedStream, B: OrderedStream<Data = A::Data, Ordering = A::Ordering>,

source§

fn is_terminated(&self) -> bool

Returns true if the stream should no longer be polled.
source§

impl<A, B> OrderedStream for Join<A, B>
where A: OrderedStream, B: OrderedStream<Data = A::Data, Ordering = A::Ordering>,

source§

type Data = <A as OrderedStream>::Data

The unordered data carried by this stream Read more
source§

type Ordering = <A as OrderedStream>::Ordering

The type ordered by this stream. Read more
source§

fn poll_next_before( self: Pin<&mut Self>, cx: &mut Context<'_>, before: 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. Read more
source§

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

The minimum value of the ordering for any future items. Read more
source§

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

Returns the bounds on the remaining length of the stream.
source§

impl<'__pin, A, B> Unpin for Join<A, B>
where PinnedFieldsOf<__Origin<'__pin, A, B>>: Unpin, A: OrderedStream, B: OrderedStream<Data = A::Data, Ordering = A::Ordering>,

Auto Trait Implementations§

§

impl<A, B> Freeze for Join<A, B>

§

impl<A, B> RefUnwindSafe for Join<A, B>

§

impl<A, B> Send for Join<A, B>
where A: Send, B: Send, <A as OrderedStream>::Data: Send, <A as OrderedStream>::Ordering: Send,

§

impl<A, B> Sync for Join<A, B>
where A: Sync, B: Sync, <A as OrderedStream>::Data: Sync, <A as OrderedStream>::Ordering: Sync,

§

impl<A, B> UnwindSafe for Join<A, B>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> OrderedStreamExt for T
where T: OrderedStream + ?Sized,

source§

fn map<F, R>(self, f: F) -> Map<Self, F>
where Self: Sized, F: FnMut(Self::Data) -> R,

Apply a closure to the data. Read more
source§

fn map_item<F, R>(self, f: F) -> MapItem<Self, F>
where Self: Sized, F: FnMut(&Self::Ordering, Self::Data) -> R,

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,

Apply a closure to the items that can change the type of the ordering value. Read more
source§

fn filter<F>(self, filter: F) -> Filter<Self, F>
where Self: Sized, F: FnMut(&Self::Data) -> bool,

source§

fn filter_map<F, R>(self, filter: F) -> FilterMap<Self, F>
where Self: Sized, F: FnMut(Self::Data) -> Option<R>,

source§

fn then<F, Fut>(self, then: F) -> Then<Self, F, Fut>
where Self: Sized, F: FnMut(Self::Data) -> Fut, Fut: Future,

Apply a closure that produces a Future to items, running the future on each item in sequence before processing the next. Read more
source§

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,

Convert this into a Stream, keeping the ordering objects.
source§

fn into_ordering(self) -> IntoOrdering<Self>
where Self: Sized,

Convert this into a Stream, keeping only the ordering objects.
source§

fn next(&mut self) -> Next<'_, Self>
where Self: Unpin,

Return the next item in this stream.
source§

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.
source§

fn peekable(self) -> Peekable<Self>
where Self: Sized,

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.