Struct secc::SeccSender

pub struct SeccSender<T: Sync + Send + Clone> { /* fields omitted */ }

Sender side of the channel.

Methods

impl<T: Sync + Send + Clone> SeccSender<T>

pub fn send(&self, message: T) -> Result<(), SeccErrors<T>>

Sends a message, which will be moved into the channel. This function will either return an empty [std::Result::Ok] or an [std::Result::Err] containing the last message sent if something went wrong.

pub fn send_await_timeout(
    &self,
    message: T,
    timeout: Duration
) -> Result<(), SeccErrors<T>>

Send to the channel, awaiting capacity if necessary up to a given timeout. This function is semantically identical to SeccSender::send but simply waits for there to be space in the channel before sending.

pub fn send_await(&self, message: T) -> Result<(), SeccErrors<T>>

Trait Implementations

impl<T: Sync + Send + Clone> SeccCoreOps<T> for SeccSender<T>

fn core(&self) -> &SeccCore<T>

Fetch the core of the channel.

fn capacity(&self) -> usize

Returns the capacity of the channel.

fn awaited_messages(&self) -> usize

Count of the number of times receivers of this channel waited for messages.

fn awaited_capacity(&self) -> usize

Count of the number of times senders to the channel waited for capacity.

fn pending(&self) -> usize

Returns the number of items are in the channel currently without regard to cursors.

fn receivable(&self) -> usize

Number of messages in the channel that are available to be received. This will normally be the same as pending unless there is a skip cursor active; in which case it may be smaller than pending or even 0.

fn sent(&self) -> usize

Returns the total number of messages that have been sent to the channel.

fn received(&self) -> usize

Returns the total number of messages that have been received from the channel.

impl<T: Send + Sync + Clone> Send for SeccSender<T>

impl<T: Send + Sync + Clone> Sync for SeccSender<T>

impl<T: Sync + Send + Clone> Clone for SeccSender<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Sync + Send + Clone> Debug for SeccSender<T>

This function will write a debug string for the SeccSender but be warned that it will acquire the mutex lock to the send_ptrs to accomplish this so a deadlock could ensue if you have two threads asking for debug on both SeccSender and SeccReceiver, especially if they are doing so in a different order.

fn fmt(&self, formatter: &mut Formatter) -> Result

Formats the value using the given formatter.