Struct JoinMultiple

pub struct JoinMultiple<C>(pub C);

Expand description

Join a collection of OrderedStreams.

This is similar to repeatedly using join() on all the streams in the contained collection. It is not optimized to avoid polling streams that are not ready, so it works best if the number of streams is relatively small.

Tuple Fields§

§0: C

Trait Implementations§

impl<C: Clone> Clone for JoinMultiple<C>

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

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl<C: Debug> Debug for JoinMultiple<C>

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

Formats the value using the given formatter. Read more

impl<C: Default> Default for JoinMultiple<C>

fn default() -> JoinMultiple<C>

Returns the “default value” for a type. Read more

impl<C, S> FusedOrderedStream for JoinMultiple<C>
where for<'a> &'a mut C: IntoIterator<Item = &'a mut Peekable<S>>, for<'a> &'a C: IntoIterator<Item = &'a Peekable<S>>, S: OrderedStream + Unpin, S::Ordering: Clone,

fn is_terminated(&self) -> bool

Returns true if the stream should no longer be polled.

impl<C, S> OrderedStream for JoinMultiple<C>
where for<'a> &'a mut C: IntoIterator<Item = &'a mut Peekable<S>>, S: OrderedStream + Unpin, S::Ordering: Clone,

type Ordering = <S as OrderedStream>::Ordering

The type ordered by this stream. Read more

type Data = <S as OrderedStream>::Data

The unordered data carried by this stream Read more

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. Read more

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

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

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

Returns the bounds on the remaining length of the stream.

impl<C> Unpin for JoinMultiple<C>

Auto Trait Implementations§

impl<C> Freeze for JoinMultiple<C>
where C: Freeze,

impl<C> RefUnwindSafe for JoinMultiple<C>
where C: RefUnwindSafe,

impl<C> Send for JoinMultiple<C>
where C: Send,

impl<C> Sync for JoinMultiple<C>
where C: Sync,

impl<C> UnwindSafe for JoinMultiple<C>
where C: UnwindSafe,

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dst. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

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

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

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.

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>
where Self: Sized, F: FnMut(&Self::Data) -> bool,

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

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

fn into_stream(self) -> IntoStream<Self>
where Self: Sized,

Convert this into a Stream, discarding the ordering information.

fn into_tuple_stream(self) -> IntoTupleStream<Self>
where Self: Sized,

Convert this into a Stream, keeping the ordering objects.

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

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

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

Return the next item in this stream.

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.

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

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.