Struct futures_util::compat::CompatSink

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

Converts a futures 0.3 Sink object to a futures 0.1-compatible version

Methods

impl<T, Item> CompatSink<T, Item>

pub fn new(inner: T) -> Self

Creates a new CompatSink.

pub fn get_ref(&self) -> &T

Get a reference to 0.3 Sink contained within.

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

Get a mutable reference to 0.3 Sink contained within.

pub fn into_inner(self) -> T

Returns the inner item.

Trait Implementations

impl<T: Debug, Item: Debug> Debug for CompatSink<T, Item>

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

Formats the value using the given formatter.

impl<T, Item> Sink for CompatSink<T, Item> where
    T: Sink03<Item> + Unpin, 

type SinkItem = Item

The type of value that the sink accepts.

type SinkError = T::Error

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

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

Begin the process of sending a value to the sink.

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

Flush all output from this sink, if necessary.

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

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

fn wait(self) -> Wait<Self>

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 as IntoFuture>::Error: From<Self::SinkError>, 

Composes a function in front of the sink.

fn with_flat_map<U, F, St>(self, f: F) -> WithFlatMap<Self, U, F, St> where
    F: FnMut(U) -> St,
    St: Stream<Item = Self::SinkItem, Error = Self::SinkError>, 

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, 

Transforms the error returned by the sink.

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

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>

Adds a fixed-size buffer to the current sink.

fn fanout<S>(self, other: S) -> Fanout<Self, S> where
    S: Sink<SinkItem = Self::SinkItem, SinkError = Self::SinkError>,
    Self::SinkItem: Clone, 

Fanout items to multiple sinks.

fn flush(self) -> Flush<Self>

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

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

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 as Stream>::Error>, 

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