[−][src]Trait futures_sink::Sink

#[must_use = "sinks do nothing unless polled"]

pub trait Sink<Item> {
type SinkError;
    fn poll_ready(
        self: Pin<&mut Self>, 
        cx: &mut Context
    ) -> Poll<Result<(), Self::SinkError>>;

    fn start_send(
        self: Pin<&mut Self>, 
        item: Item
    ) -> Result<(), Self::SinkError>;

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

    fn poll_close(
        self: Pin<&mut Self>, 
        cx: &mut Context
    ) -> Poll<Result<(), Self::SinkError>>;
}

A Sink is a value into which other values can be sent, asynchronously.

Basic examples of sinks include the sending side of:

In addition to such "primitive" sinks, it's typical to layer additional functionality, such as buffering, on top of an existing sink.

Sending to a sink is "asynchronous" in the sense that the value may not be sent in its entirety immediately. Instead, values are sent in a two-phase way: first by initiating a send, and then by polling for completion. This two-phase setup is analogous to buffered writing in synchronous code, where writes often succeed immediately, but internally are buffered and are actually written only upon flushing.

In addition, the Sink may be full, in which case it is not even possible to start the sending process.

As with Future and Stream, the Sink trait is built from a few core required methods, and a host of default methods for working in a higher-level way. The Sink::send_all combinator is of particular importance: you can use it to send an entire stream to a sink, which is the simplest way to ultimately consume a stream.

Associated Types

type SinkError

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

Loading content...

Required methods

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

Attempts to prepare the Sink to receive a value.

This method must be called and return Ok(Poll::Ready(())) prior to each call to start_send.

This method returns Poll::Ready once the underlying sink is ready to receive data. If this method returns Poll::Pending, the current task is registered to be notified (via cx.waker().wake_by_ref()) when poll_ready should be called again.

In most cases, if the sink encounters an error, the sink will permanently be unable to receive items.

fn start_send(self: Pin<&mut Self>, item: Item) -> 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(Poll::Ready(())).

As the name suggests, this method only begins the process of sending the item. If the sink employs buffering, the item isn't fully processed until the buffer is fully flushed. Since sinks are designed to work with asynchronous I/O, the process of actually writing out the data to an underlying object takes place asynchronously. You must use poll_flush or poll_close in order to guarantee completion of a send.

Implementations of poll_ready and start_send will usually involve flushing behind the scenes in order to make room for new messages. It is only necessary to call poll_flush if you need to guarantee that all of the items placed into the Sink have been sent.

In most cases, if the sink encounters an error, the sink will permanently be unable to receive items.

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

Flush any remaining output from this sink.

Returns Ok(Poll::Ready(())) when no buffered items remain. If this value is returned then it is guaranteed that all previous values sent via start_send have been flushed.

Returns Ok(Poll::Pending) if there is more work left to do, in which case the current task is scheduled (via cx.waker().wake_by_ref()) to wake up when poll_flush should be called again.

In most cases, if the sink encounters an error, the sink will permanently be unable to receive items.

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

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

Returns Ok(Poll::Ready(())) when no buffered items remain and the sink has been successfully closed.

Returns Ok(Poll::Pending) if there is more work left to do, in which case the current task is scheduled (via cx.waker().wake_by_ref()) to wake up when poll_close should be called again.

If this function encounters an error, the sink should be considered to have failed permanently, and no more Sink methods should be called.

Loading content...

Implementations on Foreign Types

impl<'a, S: ?Sized + Sink<Item> + Unpin, Item> Sink<Item> for &'a mut S[src]

type SinkError = S::SinkError

impl<'a, S: ?Sized + Sink<Item>, Item> Sink<Item> for Pin<&'a mut S>[src]

type SinkError = S::SinkError

impl<T> Sink<T> for Sender<T>[src]

type SinkError = SendError

impl<T> Sink<T> for UnboundedSender<T>[src]

type SinkError = SendError

impl<'a, T> Sink<T> for &'a UnboundedSender<T>[src]

type SinkError = SendError

impl<T> Sink<T> for Vec<T>[src]

type SinkError = VecSinkError

impl<T> Sink<T> for VecDeque<T>[src]

type SinkError = VecSinkError

impl<S: ?Sized + Sink<Item> + Unpin, Item> Sink<Item> for Box<S>[src]

type SinkError = S::SinkError

impl<A, B, Item> Sink<Item> for Either<A, B> where
    A: Sink<Item>,
    B: Sink<Item, SinkError = A::SinkError>, [src]

type SinkError = A::SinkError

Loading content...

Implementors

Loading content...