Trait Sink

pub trait Sink<Item> {
    type Error;

    // Required methods
    fn send(
        &mut self,
        item: Item,
    ) -> impl Future<Output = Result<(), Self::Error>>;
    fn flush(&mut self) -> impl Future<Output = Result<(), Self::Error>>;
    fn close(&mut self) -> impl Future<Output = Result<(), Self::Error>>;
}

A Sink is a value into which other values can be sent in pure async/await.

Required Associated Types

type Error

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

Required Methods

fn send(&mut self, item: Item) -> impl Future<Output = Result<(), Self::Error>>

Send item.

fn flush(&mut self) -> impl Future<Output = Result<(), Self::Error>>

Flush any remaining output from this sink.

fn close(&mut self) -> impl Future<Output = Result<(), Self::Error>>

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

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl<T, S: ?Sized + Sink<T>> Sink<T> for &mut S

type Error = <S as Sink<T>>::Error

fn send(&mut self, item: T) -> impl Future<Output = Result<(), Self::Error>>

fn flush(&mut self) -> impl Future<Output = Result<(), Self::Error>>

fn close(&mut self) -> impl Future<Output = Result<(), Self::Error>>

Implementors