[−][src]Struct futures::stream::Zip

#[must_use = "streams do nothing unless polled"]

pub struct Zip<St1, St2> where
    St1: Stream,
    St2: Stream,  { /* fields omitted */ }

Stream for the zip method.

Methods

impl<St1, St2> Zip<St1, St2> where
    St1: Stream,
    St2: Stream, [src]

pub fn get_ref(&self) -> (&St1, &St2)[src]

Acquires a reference to the underlying streams that this combinator is pulling from.

pub fn get_mut(&mut self) -> (&mut St1, &mut St2)[src]

Acquires a mutable reference to the underlying streams that this combinator is pulling from.

Note that care must be taken to avoid tampering with the state of the stream which may otherwise confuse this combinator.

pub fn get_pin_mut(
    self: Pin<&'a mut Zip<St1, St2>>
) -> (Pin<&'a mut St1>, Pin<&'a mut St2>) where
    St1: Unpin,
    St2: Unpin, [src]

Acquires a pinned mutable reference to the underlying streams that this combinator is pulling from.

Note that care must be taken to avoid tampering with the state of the stream which may otherwise confuse this combinator.

pub fn into_inner(self) -> (St1, St2)[src]

Consumes this combinator, returning the underlying streams.

Note that this may discard intermediate state of this combinator, so care should be taken to avoid losing resources when this is called.

Trait Implementations

impl<St1, St2> Unpin for Zip<St1, St2> where
    St1: Unpin + Stream,
    St2: Unpin + Stream, [src]

impl<St1, St2> Debug for Zip<St1, St2> where
    St1: Debug + Stream,
    St2: Debug + Stream,
    <St1 as Stream>::Item: Debug,
    <St2 as Stream>::Item: Debug, [src]

impl<St1, St2> Stream for Zip<St1, St2> where
    St1: Stream,
    St2: Stream, [src]

type Item = (<St1 as Stream>::Item, <St2 as Stream>::Item)

Values yielded by the stream.

impl<St1, St2> FusedStream for Zip<St1, St2> where
    St1: Stream,
    St2: Stream, [src]

Auto Trait Implementations

impl<St1, St2> Send for Zip<St1, St2> where
    St1: Send,
    St2: Send,
    <St1 as Stream>::Item: Send,
    <St2 as Stream>::Item: Send, 

impl<St1, St2> Sync for Zip<St1, St2> where
    St1: Sync,
    St2: Sync,
    <St1 as Stream>::Item: Sync,
    <St2 as Stream>::Item: Sync, 

Blanket Implementations

impl<T> From for T[src]

impl<T, U> Into for T where
    U: From<T>, [src]

impl<T, U> TryFrom for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized, [src]

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

impl<T> BorrowMut for T where
    T: ?Sized, [src]

impl<T, U> TryInto for T where
    U: TryFrom<T>, [src]

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

The type returned in the event of a conversion error.

impl<T> StreamExt for T where
    T: Stream + ?Sized, [src]

ⓘImportant traits for Next<'_, St>
fn next(&mut self) -> Next<Self> where
    Self: Unpin, [src]

Creates a future that resolves to the next item in the stream. Read more

ⓘImportant traits for StreamFuture<St>
fn into_future(self) -> StreamFuture<Self> where
    Self: Unpin, [src]

Converts this stream into a future of (next_item, tail_of_stream). If the stream terminates, then the next item is [None]. Read more

fn map<T, F>(self, f: F) -> Map<Self, F> where
    F: FnMut(Self::Item) -> T, [src]

Maps this stream's items to a different type, returning a new stream of the resulting type. Read more

fn enumerate(self) -> Enumerate<Self>[src]

Creates a stream which gives the current iteration count as well as the next value. Read more

fn filter<Fut, F>(self, f: F) -> Filter<Self, Fut, F> where
    F: FnMut(&Self::Item) -> Fut,
    Fut: Future<Output = bool>, [src]

Filters the values produced by this stream according to the provided asynchronous predicate. Read more

fn filter_map<Fut, T, F>(self, f: F) -> FilterMap<Self, Fut, F> where
    F: FnMut(Self::Item) -> Fut,
    Fut: Future<Output = Option<T>>, [src]

Filters the values produced by this stream while simultaneously mapping them to a different type according to the provided asynchronous closure. Read more

fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F> where
    F: FnMut(Self::Item) -> Fut,
    Fut: Future, [src]

Computes from this stream's items new items of a different type using an asynchronous closure. Read more

ⓘImportant traits for Collect<St, C>
fn collect<C>(self) -> Collect<Self, C> where
    C: Default + Extend<Self::Item>, [src]

Collect all of the values of this stream into a vector, returning a future representing the result of that computation. Read more

ⓘImportant traits for Concat<St>
fn concat(self) -> Concat<Self> where
    Self::Item: Extend<<Self::Item as IntoIterator>::Item>,
    Self::Item: IntoIterator,
    Self::Item: Default, [src]

Concatenate all items of a stream into a single extendable destination, returning a future representing the end result. Read more

ⓘImportant traits for Fold<St, Fut, T, F>
fn fold<T, Fut, F>(self, init: T, f: F) -> Fold<Self, Fut, T, F> where
    F: FnMut(T, Self::Item) -> Fut,
    Fut: Future<Output = T>, [src]

Execute an accumulating asynchronous computation over a stream, collecting all the values into one final result. Read more

fn flatten(self) -> Flatten<Self> where
    Self::Item: Stream, [src]

Flattens a stream of streams into just one continuous stream. Read more

fn skip_while<Fut, F>(self, f: F) -> SkipWhile<Self, Fut, F> where
    F: FnMut(&Self::Item) -> Fut,
    Fut: Future<Output = bool>, [src]

Skip elements on this stream while the provided asynchronous predicate resolves to true. Read more

fn take_while<Fut, F>(self, f: F) -> TakeWhile<Self, Fut, F> where
    F: FnMut(&Self::Item) -> Fut,
    Fut: Future<Output = bool>, [src]

Take elements from this stream while the provided asynchronous predicate resolves to true. Read more

ⓘImportant traits for ForEach<St, Fut, F>
fn for_each<Fut, F>(self, f: F) -> ForEach<Self, Fut, F> where
    F: FnMut(Self::Item) -> Fut,
    Fut: Future<Output = ()>, [src]

Runs this stream to completion, executing the provided asynchronous closure for each element on the stream. Read more

ⓘImportant traits for ForEachConcurrent<St, Fut, F>
fn for_each_concurrent<Fut, F, impl Into>>(
    self,
    limit: impl Into>,
    f: F
) -> ForEachConcurrent<Self, Fut, F> where
    F: FnMut(Self::Item) -> Fut,
    Fut: Future<Output = ()>,
    impl Into>: Into<Option<usize>>, [src]

Runs this stream to completion, executing the provided asynchronous closure for each element on the stream concurrently as elements become available. Read more

fn take(self, n: u64) -> Take<Self>[src]

Creates a new stream of at most n items of the underlying stream. Read more

fn skip(self, n: u64) -> Skip<Self>[src]

Creates a new stream which skips n items of the underlying stream. Read more

fn fuse(self) -> Fuse<Self>[src]

Fuse a stream such that poll_next will never again be called once it has finished. This method can be used t turn any Stream into a FusedStream. Read more

ⓘImportant traits for &'_ mut F
fn by_ref(&mut self) -> &mut Self[src]

Borrows a stream, rather than consuming it. Read more

fn catch_unwind(self) -> CatchUnwind<Self> where
    Self: UnwindSafe, [src]

Catches unwinding panics while polling the stream. Read more

ⓘImportant traits for Pin<P>
fn boxed(self) -> Pin<Box<Self>>[src]

Wrap the stream in a Box, pinning it.

fn buffered(self, n: usize) -> Buffered<Self> where
    Self::Item: Future, [src]

An adaptor for creating a buffered list of pending futures. Read more

fn buffer_unordered(self, n: usize) -> BufferUnordered<Self> where
    Self::Item: Future, [src]

An adaptor for creating a buffered list of pending futures (unordered). Read more

fn zip<St>(self, other: St) -> Zip<Self, St> where
    St: Stream, [src]

An adapter for zipping two streams together. Read more

fn chain<St>(self, other: St) -> Chain<Self, St> where
    St: Stream<Item = Self::Item>, [src]

Adapter for chaining two stream. Read more

fn peekable(self) -> Peekable<Self>[src]

Creates a new stream which exposes a peek method. Read more

fn chunks(self, capacity: usize) -> Chunks<Self>[src]

An adaptor for chunking up items of the stream inside a vector. Read more

ⓘImportant traits for Forward<St, Si>
fn forward<S>(self, sink: S) -> Forward<Self, S> where
    S: Sink<Self::Ok>,
    Self: TryStream<Error = <S as Sink<Self::Ok>>::SinkError>, [src]

A future that completes after the given stream has been fully processed into the sink and the sink has been flushed and closed. Read more

fn split<Item>(self) -> (SplitSink<Self, Item>, SplitStream<Self>) where
    Self: Sink<Item>, [src]

Splits this Stream + Sink object into separate Stream and Sink objects. Read more

fn inspect<F>(self, f: F) -> Inspect<Self, F> where
    F: FnMut(&Self::Item), [src]

Do something with each item of this stream, afterwards passing it on. Read more

ⓘImportant traits for Either<A, B>
fn left_stream<B>(self) -> Either<Self, B> where
    B: Stream<Item = Self::Item>, [src]

Wrap this stream in an Either stream, making it the left-hand variant of that Either. Read more

ⓘImportant traits for Either<A, B>
fn right_stream<B>(self) -> Either<B, Self> where
    B: Stream<Item = Self::Item>, [src]

Wrap this stream in an Either stream, making it the right-hand variant of that Either. Read more

fn poll_next_unpin(&mut self, cx: &mut Context) -> Poll<Option<Self::Item>> where
    Self: Unpin, [src]

A convenience method for calling [Stream::poll_next] on [Unpin] stream types. Read more

ⓘImportant traits for SelectNextSome<'_, St>
fn select_next_some(&mut self) -> SelectNextSome<Self> where
    Self: Unpin + FusedStream, [src]

Returns a [Future] that resolves when the next item in this stream is ready. Read more