Struct Sender

pub struct Sender<T, E>(/* private fields */);

Implementations

impl<T, E> Sender<T, E>

pub fn send(&self, n: T) -> Result<(), Error<E>>

Send a single record to the receiver.

If the queue is currently full this call will block and wait for space to become available.

Panic

If this function has already returned an application-defined error, then calling this method again will panic. Handle errors on first opportunity.

pub fn send_batch<I>(&self, it: I) -> Result<(), Error<E>>

where I: Iterator<Item = T>,

Send a batch of records.

All records will be transferred. If the queue is full, this call will block until space becomes available.

pub fn try_send(&self, n: T) -> Result<(), Error<E>>

Non-blocking send.

Attempt to send a node.

pub fn send_async(&self, n: T) -> SendFuture<'_, T, E>

Return a Future that will send a record to the receiver or wait until space becomes available in the queue.

Cancel safety

The returned SendFuture is not cancel safe.

pub fn send_batch_async<I>(&self, it: I) -> SendFuture<'_, T, E>

where I: Iterator<Item = T>,

Return a Future that will send records to the receiver or wait until space becomes available in the queue.

Cancel safety

The returned SendFuture is not cancel safe.

pub fn fail(self, e: E)

Terminate the channel with an application-defined error.

This will cause the Receiver to return an Error::App(E) error.

Trait Implementations

impl<T, E> Drop for Sender<T, E>

fn drop(&mut self)

Executes the destructor for this type.