[−][src]Struct futures_util::stream::Flatten

#[must_use =
  "futures/streams/sinks do nothing unless you `.await` or poll them"]pub struct Flatten<St> where
    St: Stream,  { /* fields omitted */ }

Stream for the flatten method.

Implementations

`impl<St> Flatten<St> where St: Stream,` [src]

`pub fn get_ref(&self) -> &St`[src]

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

`pub fn get_mut(&mut self) -> &mut St`[src]

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

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

`pub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut St>ⓘNotable traits for Pin impl Future for Pin where P: Unpin + DerefMut, ::Target: Future, type Output = <::Target as Future>::Output;`[src]

Acquires a pinned mutable reference to the underlying sink or stream that this combinator is pulling from.

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

`pub fn into_inner(self) -> St`[src]

Consumes this combinator, returning the underlying sink or 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> Debug for Flatten<St> where Flatten<St, St::Item>: Debug, St: Stream,` [src]

`pub fn fmt(&self, f: &mut Formatter<'_>) -> Result`[src]

`impl<St> FusedStream for Flatten<St> where Flatten<St, St::Item>: FusedStream, St: Stream,` [src]

`pub fn is_terminated(&self) -> bool`[src]

`impl<_Item, St> Sink<_Item> for Flatten<St> where Flatten<St, St::Item>: Sink<_Item>, St: Stream,` [src]

`type Error = <Flatten<St, St::Item> as Sink<_Item>>::Error`

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

`pub fn poll_ready( self: Pin<&mut Self>, cx: &mut Context<'_> ) -> Poll<Result<(), Self::Error>>`[src]

`pub fn start_send(self: Pin<&mut Self>, item: _Item) -> Result<(), Self::Error>`[src]

`pub fn poll_flush( self: Pin<&mut Self>, cx: &mut Context<'_> ) -> Poll<Result<(), Self::Error>>`[src]

`pub fn poll_close( self: Pin<&mut Self>, cx: &mut Context<'_> ) -> Poll<Result<(), Self::Error>>`[src]

`impl<St> Stream for Flatten<St> where Flatten<St, St::Item>: Stream, St: Stream,` [src]

`type Item = <Flatten<St, St::Item> as Stream>::Item`

Values yielded by the stream.

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

`pub fn size_hint(&self) -> (usize, Option<usize>)`[src]

`impl<'pin, St> Unpin for Flatten<St> where St: Stream, __Flatten<'pin, St>: Unpin,` [src]

Auto Trait Implementations

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

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

Blanket Implementations

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

`pub fn type_id(&self) -> TypeId`[src]

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

`pub fn borrow(&self) -> &T`[src]

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

`pub fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T> From<T> for T`[src]

`pub fn from(t: T) -> T`[src]

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

`pub fn into(self) -> U`[src]

`impl<T, Item> SinkExt<Item> for T where T: Sink<Item> + ?Sized,` [src]

`pub fn with<U, Fut, F, E>(self, f: F) -> With<Self, Item, U, Fut, F> where F: FnMut(U) -> Fut, Fut: Future<Output = Result<Item, E>>, E: From<Self::Error>, Self: Sized,` [src]

`pub fn with_flat_map<U, St, F>(self, f: F) -> WithFlatMap<Self, Item, U, St, F> where F: FnMut(U) -> St, St: Stream<Item = Result<Item, Self::Error>>, Self: Sized,` [src]

`pub fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F> where F: FnOnce(Self::Error) -> E, Self: Sized,` [src]

`pub fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E> where Self: Sized, Self::Error: Into<E>,` [src]

`pub fn buffer(self, capacity: usize) -> Buffer<Self, Item> where Self: Sized,` [src]

`pub fn close(&mut self) -> Close<'_, Self, Item>ⓘNotable traits for Close<'_, Si, Item> impl<Si: Sink<Item> + Unpin + ?Sized, Item, '_> Future for Close<'_, Si, Item> type Output = Result<(), Si::Error>; where Self: Unpin,` [src]

`pub fn fanout<Si>(self, other: Si) -> Fanout<Self, Si> where Self: Sized, Item: Clone, Si: Sink<Item, Error = Self::Error>,` [src]

`pub fn flush(&mut self) -> Flush<'_, Self, Item>ⓘNotable traits for Flush<'_, Si, Item> impl<Si: Sink<Item> + Unpin + ?Sized, Item, '_> Future for Flush<'_, Si, Item> type Output = Result<(), Si::Error>; where Self: Unpin,` [src]

`pub fn send(&mut self, item: Item) -> Send<'_, Self, Item>ⓘNotable traits for Send<'_, Si, Item> impl<Si: Sink<Item> + Unpin + ?Sized, Item, '_> Future for Send<'_, Si, Item> type Output = Result<(), Si::Error>; where Self: Unpin,` [src]

`pub fn send_all<'a, St: ?Sized>( &'a mut self, stream: &'a mut St ) -> SendAll<'a, Self, St>ⓘNotable traits for SendAll<'_, Si, St> impl<Si: ?Sized, St: ?Sized, Ok, Error, '_> Future for SendAll<'_, Si, St> where Si: Sink<Ok, Error = Error> + Unpin, St: Stream<Item = Result<Ok, Error>> + Unpin, type Output = Result<(), Error>; where St: TryStream<Ok = Item, Error = Self::Error> + Stream + Unpin, Self: Unpin,` [src]

`pub fn left_sink<Si2>(self) -> Either<Self, Si2>ⓘNotable traits for Either<A, B> impl<A, B> Future for Either<A, B> where A: Future, B: Future<Output = A::Output>, type Output = A::Output; where Si2: Sink<Item, Error = Self::Error>, Self: Sized,` [src]

`pub fn right_sink<Si1>(self) -> Either<Si1, Self>ⓘNotable traits for Either<A, B> impl<A, B> Future for Either<A, B> where A: Future, B: Future<Output = A::Output>, type Output = A::Output; where Si1: Sink<Item, Error = Self::Error>, Self: Sized,` [src]

`pub fn poll_ready_unpin( &mut self, cx: &mut Context<'_> ) -> Poll<Result<(), Self::Error>> where Self: Unpin,` [src]

`pub fn start_send_unpin(&mut self, item: Item) -> Result<(), Self::Error> where Self: Unpin,` [src]

`pub fn poll_flush_unpin( &mut self, cx: &mut Context<'_> ) -> Poll<Result<(), Self::Error>> where Self: Unpin,` [src]

`pub fn poll_close_unpin( &mut self, cx: &mut Context<'_> ) -> Poll<Result<(), Self::Error>> where Self: Unpin,` [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.

`pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>`[src]

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

`type Error = >::Error`

The type returned in the event of a conversion error.

`pub fn try_into(self) -> Result<U, >::Error>`[src]

`impl<S, T, E> TryStream for S where S: Stream<Item = Result<T, E>> + ?Sized,` [src]

`type Ok = T`

The type of successful values yielded by this future

`type Error = E`

The type of failures yielded by this future

`pub fn try_poll_next( self: Pin<&mut S>, cx: &mut Context<'_> ) -> Poll<Option<Result<<S as TryStream>::Ok, <S as TryStream>::Error>>>`[src]

[−][src]Struct futures_util::stream::Flatten

Implementations

impl<St> Flatten<St> where St: Stream, [src]

pub fn get_ref(&self) -> &St[src]

pub fn get_mut(&mut self) -> &mut St[src]

pub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut St>ⓘNotable traits for Pin<P>impl<P> Future for Pin<P> where P: Unpin + DerefMut, <P as Deref>::Target: Future, type Output = <<P as Deref>::Target as Future>::Output;[src]

Notable traits for Pin<P>

pub fn into_inner(self) -> St[src]

Trait Implementations

impl<St> Debug for Flatten<St> where Flatten<St, St::Item>: Debug, St: Stream, [src]

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

impl<St> FusedStream for Flatten<St> where Flatten<St, St::Item>: FusedStream, St: Stream, [src]

pub fn is_terminated(&self) -> bool[src]

impl<_Item, St> Sink<_Item> for Flatten<St> where Flatten<St, St::Item>: Sink<_Item>, St: Stream, [src]

type Error = <Flatten<St, St::Item> as Sink<_Item>>::Error

pub fn poll_ready( self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>[src]

pub fn start_send(self: Pin<&mut Self>, item: _Item) -> Result<(), Self::Error>[src]

pub fn poll_flush( self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>[src]

pub fn poll_close( self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>[src]

impl<St> Stream for Flatten<St> where Flatten<St, St::Item>: Stream, St: Stream, [src]

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

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

pub fn size_hint(&self) -> (usize, Option<usize>)[src]

impl<'pin, St> Unpin for Flatten<St> where St: Stream, __Flatten<'pin, St>: Unpin, [src]

Auto Trait Implementations

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

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

Blanket Implementations

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

pub fn type_id(&self) -> TypeId[src]

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

pub fn borrow(&self) -> &T[src]

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

pub fn borrow_mut(&mut self) -> &mut T[src]

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

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

pub fn into(self) -> U[src]

impl<T, Item> SinkExt<Item> for T where T: Sink<Item> + ?Sized, [src]

pub fn with<U, Fut, F, E>(self, f: F) -> With<Self, Item, U, Fut, F> where F: FnMut(U) -> Fut, Fut: Future<Output = Result<Item, E>>, E: From<Self::Error>, Self: Sized, [src]

pub fn with_flat_map<U, St, F>(self, f: F) -> WithFlatMap<Self, Item, U, St, F> where F: FnMut(U) -> St, St: Stream<Item = Result<Item, Self::Error>>, Self: Sized, [src]

pub fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F> where F: FnOnce(Self::Error) -> E, Self: Sized, [src]

pub fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E> where Self: Sized, Self::Error: Into<E>, [src]

pub fn buffer(self, capacity: usize) -> Buffer<Self, Item> where Self: Sized, [src]

pub fn close(&mut self) -> Close<'_, Self, Item>ⓘNotable traits for Close<'_, Si, Item>impl<Si: Sink<Item> + Unpin + ?Sized, Item, '_> Future for Close<'_, Si, Item> type Output = Result<(), Si::Error>; where Self: Unpin, [src]

Notable traits for Close<'_, Si, Item>

pub fn fanout<Si>(self, other: Si) -> Fanout<Self, Si> where Self: Sized, Item: Clone, Si: Sink<Item, Error = Self::Error>, [src]

pub fn flush(&mut self) -> Flush<'_, Self, Item>ⓘNotable traits for Flush<'_, Si, Item>impl<Si: Sink<Item> + Unpin + ?Sized, Item, '_> Future for Flush<'_, Si, Item> type Output = Result<(), Si::Error>; where Self: Unpin, [src]

Notable traits for Flush<'_, Si, Item>

pub fn send(&mut self, item: Item) -> Send<'_, Self, Item>ⓘNotable traits for Send<'_, Si, Item>impl<Si: Sink<Item> + Unpin + ?Sized, Item, '_> Future for Send<'_, Si, Item> type Output = Result<(), Si::Error>; where Self: Unpin, [src]

Notable traits for Send<'_, Si, Item>

Notable traits for SendAll<'_, Si, St>

pub fn left_sink<Si2>(self) -> Either<Self, Si2>ⓘNotable traits for Either<A, B>impl<A, B> Future for Either<A, B> where A: Future, B: Future<Output = A::Output>, type Output = A::Output; where Si2: Sink<Item, Error = Self::Error>, Self: Sized, [src]

Notable traits for Either<A, B>

pub fn right_sink<Si1>(self) -> Either<Si1, Self>ⓘNotable traits for Either<A, B>impl<A, B> Future for Either<A, B> where A: Future, B: Future<Output = A::Output>, type Output = A::Output; where Si1: Sink<Item, Error = Self::Error>, Self: Sized, [src]