Struct flume::async::SendSink

pub struct SendSink<'a, T>(_);

A sink that allows sending values into a channel.

Can be created via Sender::sink or Sender::into_sink.

Implementations

impl<'a, T> SendSink<'a, T>

pub fn sender(&self) -> &Sender<T>

Returns a clone of a sending half of the channel of this sink.

pub fn is_disconnected(&self) -> bool

See Sender::is_disconnected.

pub fn is_empty(&self) -> bool

See Sender::is_empty.

pub fn is_full(&self) -> bool

See Sender::is_full.

pub fn len(&self) -> usize

See Sender::len.

pub fn capacity(&self) -> Option<usize>

See Sender::capacity.

Trait Implementations

impl<'a, T> Clone for SendSink<'a, T>

fn clone(&self) -> SendSink<'a, T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a, T> Sink<T> for SendSink<'a, T>

type Error = SendError<T>

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

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

Attempts to prepare the Sink to receive a value.

fn start_send(self: Pin<&mut Self>, item: T) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

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

Flush any remaining output from this sink.

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

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