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

pub struct Drain<T> { /* fields omitted */ }

This is supported on crate feature sink only.

Expand description

Sink for the drain function.

Trait Implementations

[src]

impl<T: Debug> Debug for Drain<T>

[src]

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

Formats the value using the given formatter. Read more

[src]

impl<T> Sink<T> for Drain<T>

type Error = Never

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

[src]

fn poll_ready(
self: Pin<&mut Self>,
_cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value. Read more

[src]

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

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

[src]

fn poll_flush(
self: Pin<&mut Self>,
_cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink. Read more

[src]

fn poll_close(
self: Pin<&mut Self>,
_cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

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

[src]

impl<T> Unpin for Drain<T>

Auto Trait Implementations

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

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

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

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

Blanket Implementations

[src]

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

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

impl<T> Borrow<T> for T where
T: ?Sized,

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

impl<T> BorrowMut<T> for T where
T: ?Sized,

[src]

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

impl<T, U> Into for T where
U: From<T>,

[src]

pub fn into(self) -> U

Performs the conversion.

[src]

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,

This is supported on crate feature sink only.

Composes a function in front of the sink. Read more

[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,

This is supported on crate feature sink only.

Composes a function in front of the sink. Read more

[src]

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

This is supported on crate feature sink only.

Transforms the error returned by the sink.

[src]

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

This is supported on crate feature sink only.

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

[src]

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

This is supported on crate feature sink only.

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

[src]

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,

This is supported on crate feature sink only.

Close the sink.

[src]

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

This is supported on crate feature sink only.

Fanout items to multiple sinks. Read more

[src]

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,

This is supported on crate feature sink only.

Flush the sink, processing all pending items. Read more

[src]

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,

This is supported on crate feature sink only.

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

[src]

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

This is supported on crate feature sink only.

A future that completes after the given item has been received by the sink. Read more

[src]

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 + ?Sized, St: Stream<Item = Result<Ok, Error>> + Unpin + ?Sized, type Output = Result<(), Error>;`
where
 St: TryStream<Ok = Item, Error = Self::Error> + Stream + Unpin + ?Sized,
 Self: Unpin,

This is supported on crate feature sink only.

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

[src]

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,

This is supported on crate feature sink only.

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

[src]

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,

This is supported on crate feature sink only.

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

[src]

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

This is supported on crate features sink and compat only.

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

[src]

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

This is supported on crate feature sink only.

A convenience method for calling Sink::poll_ready on Unpin sink types. Read more

[src]

fn start_send_unpin(&mut self, item: Item) -> Result<(), Self::Error> where
Self: Unpin,

This is supported on crate feature sink only.

A convenience method for calling Sink::start_send on Unpin sink types. Read more

[src]

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

This is supported on crate feature sink only.

A convenience method for calling Sink::poll_flush on Unpin sink types. Read more

[src]

fn poll_close_unpin(
 &mut self,
 cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>> where
 Self: Unpin,

This is supported on crate feature sink only.

A convenience method for calling Sink::poll_close on Unpin sink types. Read more

[src]

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

[src]

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

Performs the conversion.

[src]

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

[src]

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

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

Trait Implementations

impl<T: Debug> Debug for Drain<T>

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

impl<T> Sink<T> for Drain<T>

type Error = Never

fn poll_ready( self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

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

fn poll_flush( self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

fn poll_close( self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

impl<T> Unpin for Drain<T>

Auto Trait Implementations

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

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

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

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

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

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

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,

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,

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

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

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

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,

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

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,

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,

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

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,

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,

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

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

fn start_send_unpin(&mut self, item: Item) -> Result<(), Self::Error> where Self: Unpin,

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

fn poll_close_unpin( &mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> where Self: Unpin,

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

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

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

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

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

fn poll_ready(
self: Pin<&mut Self>,
_cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

fn poll_flush(
self: Pin<&mut Self>,
_cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

fn poll_close(
self: Pin<&mut Self>,
_cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

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

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

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

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

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

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

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

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,

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,

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

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

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

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,

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

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,

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,

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

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,

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,

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

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

fn start_send_unpin(&mut self, item: Item) -> Result<(), Self::Error> where
Self: Unpin,

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

fn poll_close_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>> where
Self: Unpin,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,