Struct futures::sink::Drain

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

Sink for the drain function.

Trait Implementations

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

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

Formats the value using the given formatter.

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

type Error = Infallible

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

pub fn poll_ready(
    self: Pin<&mut Drain<T>>,
    _cx: &mut Context<'_>
) -> Poll<Result<(), <Drain<T> as Sink<T>>::Error>>

Attempts to prepare the Sink to receive a value.

pub fn start_send(
    self: Pin<&mut Drain<T>>,
    _item: T
) -> Result<(), <Drain<T> as Sink<T>>::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(())).

pub fn poll_flush(
    self: Pin<&mut Drain<T>>,
    _cx: &mut Context<'_>
) -> Poll<Result<(), <Drain<T> as Sink<T>>::Error>>

Flush any remaining output from this sink.

pub fn poll_close(
    self: Pin<&mut Drain<T>>,
    _cx: &mut Context<'_>
) -> Poll<Result<(), <Drain<T> as Sink<T>>::Error>>

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

impl<T> Unpin for Drain<T>