Struct futures_util::future::FlattenSink

pub struct FlattenSink<F> where
    F: Future,
    <F as Future>::Item: Sink,  { /* fields omitted */ }

Future for the flatten_sink combinator, flattening a future-of-a-sink to get just the result of the final sink as a sink.

This is created by the Future::flatten_sink method.

Trait Implementations

impl<F> Debug for FlattenSink<F> where
    F: Future + Debug,
    <F as Future>::Item: Sink<SinkError = F::Error> + Debug, 

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

Formats the value using the given formatter.

impl<F> Sink for FlattenSink<F> where
    F: Future,
    <F as Future>::Item: Sink<SinkError = F::Error>, 

type SinkItem = <<F as Future>::Item as Sink>::SinkItem

The type of value that the sink accepts.

type SinkError = <<F as Future>::Item as Sink>::SinkError

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

fn poll_ready(&mut self, cx: &mut Context) -> Result<Async<()>, Self::SinkError>

Attempts to prepare the Sink to receive a value.

fn start_send(&mut self, item: Self::SinkItem) -> Result<(), Self::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(Async::Ready(())).

fn poll_flush(&mut self, cx: &mut Context) -> Result<Async<()>, Self::SinkError>

Flush any remaining output from this sink.

fn poll_close(&mut self, cx: &mut Context) -> Result<Async<()>, Self::SinkError>

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