Struct ordered_stream::Join

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

A stream for the join function.

Implementations

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

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.

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.

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.

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.

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

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,

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

Formats the value using the given formatter.

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

fn is_terminated(&self) -> bool

Returns true if the stream should no longer be polled.

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

type Data = <A as OrderedStream>::Data

The unordered data carried by this stream

type Ordering = <A as OrderedStream>::Ordering

The type ordered by this stream.

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.

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, A, B> Unpin for Join<A, B>where
    __Origin<'__pin, A, B>: Unpin,
    A: OrderedStream,
    B: OrderedStream<Data = A::Data, Ordering = A::Ordering>,