Struct nolock::queues::spsc::bounded::BoundedSender

pub struct BoundedSender<T> { /* fields omitted */ }

The Sending-Half for the queue

Implementations

impl<T> BoundedSender<T>

pub fn is_closed(&self) -> bool

Returns whether or not the Queue has been closed by the Consumer

Example

let (rx, tx) = bounded::queue::<usize>(3);

// Drop the Consumer and therefore also close the Queue
drop(rx);

assert_eq!(true, tx.is_closed());

pub fn try_enqueue(&mut self, data: T) -> Result<(), (T, EnqueueError)>

Attempts to Enqueue the given piece of Data

Example:

Enqueue Data when there is still space

// Create a new Queue with the capacity for 16 Elements
let (mut rx, mut tx) = bounded::queue::<usize>(16);

// Enqueue some Data
assert_eq!(Ok(()), tx.try_enqueue(13));

Enqueue Data when there is no more space

// Create a new Queue with the capacity for 16 Elements
let (mut rx, mut tx) = bounded::queue::<usize>(16);

// Fill up the Queue
for i in 0..16 {
  assert_eq!(Ok(()), tx.try_enqueue(i));
}

// Attempt to enqueue some Data, but there is no more room
assert_eq!(Err((13, EnqueueError::WouldBlock)), tx.try_enqueue(13));

pub fn enqueue(&mut self, data: T) -> Result<(), (T, EnqueueError)>

A blocking enqueue Operation. This is obviously not lock-free anymore and will simply spin while trying to enqueue the Data until it works

pub fn is_full(&self) -> bool

Checks if the current Queue is full

Trait Implementations

impl<T> Debug for BoundedSender<T>

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

Formats the value using the given formatter.

impl<T> Drop for BoundedSender<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> Send for BoundedSender<T>

impl<T> Sync for BoundedSender<T>