Struct futures::sink::SinkMapErr

#[must_use = "sinks do nothing unless polled"]
pub struct SinkMapErr<S, F> { /* fields omitted */ }

Sink for the Sink::sink_map_err combinator.

Methods

impl<S, E> SinkMapErr<S, E>

fn get_ref(&self) -> &S

Get a shared reference to the inner sink.

fn get_mut(&mut self) -> &mut S

Get a mutable reference to the inner sink.

fn into_inner(self) -> S

Consumes this combinator, returning the underlying sink.

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<S: Debug, F: Debug> Debug for SinkMapErr<S, F>

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

Formats the value using the given formatter.

impl<S, F, E> Sink for SinkMapErr<S, F> where S: Sink,
        F: FnOnce(S::SinkError) -> E

type SinkItem = S::SinkItem

The type of value that the sink accepts.

type SinkError = E

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

fn start_send(&mut self,
              item: Self::SinkItem)
              -> StartSend<Self::SinkItem, Self::SinkError>

Begin the process of sending a value to the sink.

fn poll_complete(&mut self) -> Poll<(), Self::SinkError>

Flush all output from this sink, if necessary.

fn close(&mut self) -> Poll<(), Self::SinkError>

A method to indicate that no more values will ever be pushed into this sink.

fn wait(self) -> Wait<Self> where Self: Sized

Creates a new object which will produce a synchronous sink.

fn with<U, F, Fut>(self, f: F) -> With<Self, U, F, Fut> where F: FnMut(U) -> Fut,
        Fut: IntoFuture<Item=Self::SinkItem>,
        Fut::Error: From<Self::SinkError>,
        Self: Sized

Composes a function in front of the sink.

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

Transforms the error returned by the sink.

fn sink_from_err<E: From<Self::SinkError>>(self) -> SinkFromErr<Self, E> where Self: Sized

Map this sink's error to any error implementing From for this sink's Error, returning a new sink.

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

Adds a fixed-size buffer to the current sink.

fn flush(self) -> Flush<Self> where Self: Sized

A future that completes when the sink has finished processing all pending requests.

fn send(self, item: Self::SinkItem) -> Send<Self> where Self: Sized

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

fn send_all<S>(self, stream: S) -> SendAll<Self, S> where S: Stream<Item=Self::SinkItem>,
        Self::SinkError: From<S::Error>,
        Self: Sized

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