Struct futures::stream::Flatten

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

Stream for the flatten method.

Methods

impl<St> Flatten<St> where
    St: Stream + Stream,
    <St as Stream>::Item: Stream, 

Important traits for &'_ mut F

impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized,  type Output = <F as Future>::Output;

pub fn get_ref(&self) -> &St

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

Important traits for &'_ mut F

impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized,  type Output = <F as Future>::Output;

pub fn get_mut(&mut self) -> &mut St

Acquires a mutable reference to the underlying stream 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) -> St

Consumes this combinator, returning the underlying stream.

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<St> Unpin for Flatten<St> where
    St: Stream + Stream + Unpin,
    <St as Stream>::Item: Stream,
    <St as Stream>::Item: Unpin, 

impl<S, Item> Sink<Item> for Flatten<S> where
    S: Stream + Sink<Item>,
    <S as Stream>::Item: Stream, 

type SinkError = <S as Sink<Item>>::SinkError

The type of value produced by the sink when an error occurs.

fn poll_ready(
    self: Pin<&mut Flatten<S>>,
    cx: &mut Context
) -> Poll<Result<(), <Flatten<S> as Sink<Item>>::SinkError>>

Attempts to prepare the Sink to receive a value.

fn start_send(
    self: Pin<&mut Flatten<S>>,
    item: Item
) -> Result<(), <Flatten<S> as Sink<Item>>::SinkError>

Begin the process of sending a value to the sink. Each call to this function must be proceeded by a successful call to poll_ready which returned Ok(Poll::Ready(())).

fn poll_flush(
    self: Pin<&mut Flatten<S>>,
    cx: &mut Context
) -> Poll<Result<(), <Flatten<S> as Sink<Item>>::SinkError>>

Flush any remaining output from this sink.

fn poll_close(
    self: Pin<&mut Flatten<S>>,
    cx: &mut Context
) -> Poll<Result<(), <Flatten<S> as Sink<Item>>::SinkError>>

Flush any remaining output and close this sink, if necessary.

impl<St> FusedStream for Flatten<St> where
    St: Stream + FusedStream, 

fn is_terminated(&self) -> bool

Returns true if the stream should no longer be polled.

impl<St> Stream for Flatten<St> where
    St: Stream,
    <St as Stream>::Item: Stream, 

type Item = <<St as Stream>::Item as Stream>::Item

Values yielded by the stream.

fn poll_next(
    self: Pin<&mut Flatten<St>>,
    cx: &mut Context
) -> Poll<Option<<Flatten<St> as Stream>::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.

impl<St> Debug for Flatten<St> where
    St: Debug + Stream,
    <St as Stream>::Item: Debug, 

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

Formats the value using the given formatter.