Struct sync_channel::Sender

pub struct Sender<T: Send, P: DeadlockPrevention = Spin> { /* private fields */ }

The sender (transmit) side of a channel.

Implementations

impl<T: Send, P: DeadlockPrevention> Sender<T, P>

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

Send a message, blocking until space in the channel’s buffer is available.

Returns Ok(()) if the message was sent successfully, otherwise returns an Error.

pub fn send_buf(&self, buf: &[T]) -> Result<usize, Error>where T: Copy,

Sends a slice of objects through the channel, returning how many objects were sent.

This method only blocks on the first object being sent.

pub fn send_all(&self, buf: &[T]) -> Result<(), Error>where T: Copy,

Attempts to send an entire slice of objects through the channel.

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

Tries to send the message, only succeeding if buffer space is available.

If no buffer space is available, it returns the msg with Error back to the caller without blocking.

pub fn try_send_buf(&self, buf: &[T]) -> Result<usize, Error>where T: Copy,

Sends a slice of objects through the channel, returning how many objects were sent.

This method does not block.

pub fn is_disconnected(&self) -> bool

Returns true if the channel is disconnected.

pub fn receiver(&self) -> Receiver<T, P>

Obtain a Receiver endpoint connected to the same channel as this Sender.

Trait Implementations

impl<T: Send, P: DeadlockPrevention> Clone for Sender<T, P>

fn clone(&self) -> Self

Clones this Sender, returning another Sender connected to the same channel.

This increments the channel’s sender count. If there were previously no senders, the channel status is updated to Connected.

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

Performs copy-assignment from source.

impl<T: Send, P: DeadlockPrevention> Drop for Sender<T, P>

When the only remaining Sender is dropped, we mark the channel as disconnected and notify all of the Receivers

fn drop(&mut self)

Executes the destructor for this type.