Struct futures_util::stream::Zip

#[must_use = "streams do nothing unless polled"]
pub struct Zip<St1: Stream, St2: Stream> { /* fields omitted */ }

Stream for the zip method.

Implementations

impl<St1: Stream, St2: Stream> Zip<St1, St2>

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

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

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

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<&mut Self>) -> (Pin<&mut St1>, Pin<&mut St2>)

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)

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: Debug + Stream, St2: Debug + Stream> Debug for Zip<St1, St2> where
    St1::Item: Debug,
    St2::Item: Debug, 

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

Formats the value using the given formatter.

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

fn is_terminated(&self) -> bool

Returns true if the stream should no longer be polled.

impl<St1, St2> Stream for Zip<St1, St2> where
    St1: Stream,
    St2: Stream, 

type Item = (St1::Item, St2::Item)

Values yielded by the stream.

fn poll_next(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

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

Returns the bounds on the remaining length of the stream.

impl<'__pin, St1: Stream, St2: Stream> Unpin for Zip<St1, St2> where
    __Origin<'__pin, St1, St2>: Unpin,