Struct tikv_util::mpsc::Sender

pub struct Sender<T> {
    sender: Sender<T>,
    state: Arc<State>,
}

A sender that can be closed.

Closed means that sender can no longer send out any messages after closing. However, receiver may still block at receiving.

Note that a receiver should reports error in such case. However, to fully implement a close mechanism, like waking up waiting receivers, requires a cost of performance. And the mechanism is unnecessary for current usage.

TODO: use builtin close when crossbeam-rs/crossbeam#236 is resolved.

Fields

sender: Sender<T>

state: Arc<State>

Implementations

impl<T> Sender<T>

pub fn len(&self) -> usize

Returns the number of messages in the channel.

pub fn is_empty(&self) -> bool

Returns true if the channel is empty.

Note: Zero-capacity channels are always empty.

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

Blocks the current thread until a message is sent or the channel is disconnected.

pub fn try_send(&self, t: T) -> Result<(), TrySendError<T>>

Attempts to send a message into the channel without blocking.

pub fn close_sender(&self)

Stop the sender from sending any further messages.

pub fn is_sender_connected(&self) -> bool

Check if the sender is still connected.

Trait Implementations

impl<T> Clone for Sender<T>

fn clone(&self) -> Sender<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Drop for Sender<T>

fn drop(&mut self)

Executes the destructor for this type.