Struct drone_core::sync::spsc::ring::Sender

pub struct Sender<T, E> { /* fields omitted */ }

The sending-half of ring::channel.

Methods

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

pub fn send(&mut self, value: T) -> Result<(), SendError<T>>

Puts value to the ring buffer. The value can be immediately read by the receiving half.

If the value is successfully enqueued for the remote end to receive, then Ok(()) is returned. However if the receiving end was dropped before this function was called or there is the ring buffer overflow, then Err is returned with the value provided.

pub fn send_overwrite(&mut self, value: T) -> Result<(), T>

Puts value to the ring buffer. The value can be immediately read by the receiving half. This method overwrites old items on overflow.

If the value is successfully enqueued for the remote end to receive, then Ok(()) is returned. If the receiving end was dropped before this function was called, however, then Err is returned with the value provided.

pub fn send_err(self, err: E) -> Result<(), E>

Completes this channel with an Err result.

This function will consume self and indicate to the other end, the Receiver, that the channel is closed.

If the value is successfully enqueued for the remote end to receive, then Ok(()) is returned. If the receiving end was dropped before this function was called, however, then Err is returned with the value provided.

pub fn poll_cancel(self: Pin<&mut Self>, cx: &mut Context) -> Poll<()>

Polls this Sender half to detect whether its associated Receiver with has been dropped.

Return values

If Ok(Ready) is returned then the associated Receiver has been dropped.

If Ok(Pending) is returned then the associated Receiver is still alive and may be able to receive values if sent. The current task, however, is scheduled to receive a notification if the corresponding Receiver goes away.

pub fn is_canceled(&self) -> bool

Tests to see whether this Sender's corresponding Receiver has been dropped.

Unlike poll_cancel, this function does not enqueue a task for wakeup upon cancellation, but merely reports the current state, which may be subject to concurrent modification.

Trait Implementations

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

fn drop(&mut self)

Executes the destructor for this type.