Struct Sender

pub struct Sender<I, P>
where
    P: Ord,
{ /* private fields */ }

Send side of the channel. Can be cloned.

Implementations

impl<T, P> Sender<T, P>

where P: Ord,

pub fn try_send(&self, msg: T, priority: P) -> Result<(), TrySendError<(T, P)>>

Attempts to send a message into the channel.

If the channel is full or closed, this method returns an error.

pub fn try_sendv<I>( &self, msgs: Peekable<I>, ) -> Result<(), TrySendError<Peekable<I>>>

where I: Iterator<Item = (T, P)>,

Attempts to send multiple messages into the channel.

If the channel is closed, this method returns an error.

If the channel is full or nearly full, this method inserts as many messages as it can into the channel and then returns an error containing the remaining unsent messages.

pub async fn send(&self, msg: T, priority: P) -> Result<(), SendError<(T, P)>>

Sends a message into the channel.

If the channel is full, this method waits until there is space for a message.

If the channel is closed, this method returns an error.

pub async fn sendv<I>( &self, msgs: Peekable<I>, ) -> Result<(), SendError<Peekable<I>>>

where I: Iterator<Item = (T, P)>,

Send multiple messages into the channel

If the channel is full, this method waits until there is space.

If the channel is closed, this method returns an error.

pub fn close(&self) -> bool

Closes the channel and notifies all blocked operations.

Returns true if this call has closed the channel and it was not closed already.

pub fn is_closed(&self) -> bool

Returns true if the channel is closed

pub fn is_empty(&self) -> bool

Return true if the channel is empty

pub fn is_full(&self) -> bool

Return true if the channel is full

pub fn len(&self) -> u64

Returns the number of messages in the channel.

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

Returns the channel capacity if it’s bounded.

pub fn receiver_count(&self) -> usize

Returns the number of receivers for the channel.

pub fn sender_count(&self) -> usize

Returns the number of senders for the channel.

Trait Implementations

impl<I, P> Clone for Sender<I, P>

where P: Ord,

fn clone(&self) -> Sender<I, P>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I: Debug, P> Debug for Sender<I, P>

where P: Ord + Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<I, P> Drop for Sender<I, P>

where P: Ord,

fn drop(&mut self)

Executes the destructor for this type.