Struct futures::compat::CompatSink

[+] Show declaration

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

[−] Expand description

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

Methods

impl<T, Item> CompatSink<T, Item>[−]

pub fn into_inner(self) -> T[−]

Returns the inner item.

pub fn new(inner: T) -> CompatSink<T, Item>[−]

Creates a new CompatSink.

Trait Implementations

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

[+] Show hidden undocumented items

type SinkItem = Item

The type of value that the sink accepts.

type SinkError = <T as Sink<Item>>::Error

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

fn start_send(
    &mut self,
    item: <CompatSink<T, Item> as Sink>::SinkItem
) -> Result<AsyncSink<<CompatSink<T, Item> as Sink>::SinkItem>, <CompatSink<T, Item> as Sink>::SinkError>[−]

Begin the process of sending a value to the sink.

fn poll_complete(
    &mut self
) -> Result<Async<()>, <CompatSink<T, Item> as Sink>::SinkError>[−]

Flush all output from this sink, if necessary.

fn close(
    &mut self
) -> Result<Async<()>, <CompatSink<T, Item> as Sink>::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.

impl<T, Item> Debug for CompatSink<T, Item> where
    Item: Debug,
    T: Debug, [+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>[−]

Formats the value using the given formatter.