Struct ordered_stream::JoinMultiplePin

pub struct JoinMultiplePin<C> {
    pub streams: C,
}

Join a collection of pinned OrderedStreams.

This is identical to JoinMultiple, but accepts OrderedStreams that are not Unpin by requiring that the collection provide a pinned IntoIterator implementation.

This is not a feature available in most std collections. If you wish to use them, you should use Box::pin to make the stream Unpin before inserting it in the collection, and then use JoinMultiple on the resulting collection.

Fields

streams: C

Implementations

impl<C> JoinMultiplePin<C>

pub fn as_pin_mut(self: Pin<&mut Self>) -> Pin<&mut C>

Trait Implementations

impl<C: Clone> Clone for JoinMultiplePin<C>

fn clone(&self) -> JoinMultiplePin<C>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<C: Debug> Debug for JoinMultiplePin<C>

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

Formats the value using the given formatter.

impl<C: Default> Default for JoinMultiplePin<C>

fn default() -> JoinMultiplePin<C>

Returns the “default value” for a type.

impl<C, S> OrderedStream for JoinMultiplePin<C>where
    for<'a> Pin<&'a mut C>: IntoIterator<Item = Pin<&'a mut Peekable<S>>>,
    S: OrderedStream,

type Ordering = <S as OrderedStream>::Ordering

The type ordered by this stream.

type Data = <S as OrderedStream>::Data

The unordered data carried by this stream

fn poll_next_before(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    before: Option<&S::Ordering>
) -> Poll<PollResult<S::Ordering, S::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, C> Unpin for JoinMultiplePin<C>where
    __Origin<'__pin, C>: Unpin,