[−][src]Struct futures_util::sink::Drain

#[must_use = "sinks do nothing unless polled"]
pub struct Drain<T> { /* fields omitted */ }

Sink for the drain function.

Trait Implementations

`impl<T> Unpin for Drain<T>`[src]

`impl<T: Debug> Debug for Drain<T>`[src]

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

`impl<T> Sink<T> for Drain<T>`[src]

`type Error = Never`

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

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

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

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

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

Auto Trait Implementations

`impl<T> Sync for Drain<T> where T: Sync,`

`impl<T> Send for Drain<T> where T: Send,`

`impl<T> UnwindSafe for Drain<T> where T: UnwindSafe,`

`impl<T> RefUnwindSafe for Drain<T> where T: RefUnwindSafe,`

Blanket Implementations

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

`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]

Composes a function in front of the sink. Read more

`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]

Composes a function in front of the sink. Read more

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

Transforms the error returned by the sink.

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

Map this sink's error to a different error type using the Into trait. Read more

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

Adds a fixed-size buffer to the current sink. Read more

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

Close the sink.

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

Fanout items to multiple sinks. Read more

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

Flush the sync, processing all pending items. Read more

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

A future that completes after the given item has been fully processed into the sink, including flushing. Read more

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

A future that completes after the given stream has been fully processed into the sink, including flushing. Read more

ⓘImportant traits for Either<A, B>
Important 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;`
`fn left_sink<Si2>(self) -> Either<Self, Si2> where Si2: Sink<Item, Error = Self::Error>, Self: Sized,` [src]

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

ⓘImportant traits for Either<A, B>
Important 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;`
`fn right_sink<Si1>(self) -> Either<Si1, Self> where Si1: Sink<Item, Error = Self::Error>, Self: Sized,` [src]

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

`fn compat(self) -> CompatSink<Self, Item> where Self: Sized + Unpin,` [src]

Wraps a Sink into a sink compatible with libraries using futures 0.1 Sink. Requires the compat feature to be enabled. Read more

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

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

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

`fn into(self) -> U`[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.

`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.

[−][src]Struct futures_util::sink::Drain

Trait Implementations

impl<T> Unpin for Drain<T>[src]

impl<T: Debug> Debug for Drain<T>[src]

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

impl<T> Sink<T> for Drain<T>[src]

type Error = Never

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

fn start_send(self: Pin<&mut Self>, _item: T) -> Result<(), Self::Error>[src]

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

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

Auto Trait Implementations

impl<T> Sync for Drain<T> where T: Sync,

impl<T> Send for Drain<T> where T: Send,

impl<T> UnwindSafe for Drain<T> where T: UnwindSafe,

impl<T> RefUnwindSafe for Drain<T> where T: RefUnwindSafe,

Blanket Implementations

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

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]

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]

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

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

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

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

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

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

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

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

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

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

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

ⓘImportant traits for Either<A, B>Important 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;fn left_sink<Si2>(self) -> Either<Self, Si2> where Si2: Sink<Item, Error = Self::Error>, Self: Sized, [src]

Important traits for Either<A, B>

ⓘImportant traits for Either<A, B>Important 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;fn right_sink<Si1>(self) -> Either<Si1, Self> where Si1: Sink<Item, Error = Self::Error>, Self: Sized, [src]

Important traits for Either<A, B>

fn compat(self) -> CompatSink<Self, Item> where Self: Sized + Unpin, [src]

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

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

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

fn into(self) -> U[src]

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

type Error = Infallible

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

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

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

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

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

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

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

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

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

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

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

`impl<T> Unpin for Drain<T>`[src]

`impl<T: Debug> Debug for Drain<T>`[src]

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

`impl<T> Sink<T> for Drain<T>`[src]

`type Error = Never`

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

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

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

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

`impl<T> Sync for Drain<T> where T: Sync,`

`impl<T> Send for Drain<T> where T: Send,`

`impl<T> UnwindSafe for Drain<T> where T: UnwindSafe,`

`impl<T> RefUnwindSafe for Drain<T> where T: RefUnwindSafe,`

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

`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]

`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]

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

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

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

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

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

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

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

ⓘImportant traits for Either<A, B>
Important 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;`
`fn left_sink<Si2>(self) -> Either<Self, Si2> where Si2: Sink<Item, Error = Self::Error>, Self: Sized,` [src]

ⓘImportant traits for Either<A, B>
Important 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;`
`fn right_sink<Si1>(self) -> Either<Si1, Self> where Si1: Sink<Item, Error = Self::Error>, Self: Sized,` [src]

`fn compat(self) -> CompatSink<Self, Item> where Self: Sized + Unpin,` [src]

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

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

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

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

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

`type Error = Infallible`

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

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

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

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

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

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

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

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

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

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

`impl<V, T> VZip<V> for T where V: MultiLane<T>,`

`fn vzip(self) -> V`