Struct mpmcpq::Stash

pub struct Stash<'a, M, P>where
    M: Send,
    P: PartialOrd + Ord,{ /* private fields */ }

For contention free queue insertion every thread maintains a private ‘stash’. When messages are send to the PriorityQueue while it is locked they are stored in this stash. Once the lock is obtained the stashed messages will be moved to the PriorityQueue. This can also be enforced with the ‘PriorityQueue::sync()’ function.

Implementations

impl<'a, M, P> Stash<'a, M, P>where
    M: Send,
    P: PartialOrd + Ord,

pub fn new(pq: &'a PriorityQueue<M, P>) -> Self

Creates a new stash. A stash is tied to a priority queue, when the stash becomes dropped all its remaining temporary messages will be sent to the queue.

pub fn without_priority_queue() -> Self

Creates a new stash. This Stash has no reference to a priority queue, messages left here at drop time become discarded.

pub fn is_empty(&self) -> bool

Returns true when the Stash contains no messages.

pub fn len(&self) -> usize

Returns the number of messages in the stash.

Examples found in repository

src/mpmcpq.rs (line 139)

    pub fn send_batched(&self, message: M, prio: P, batch_size: usize, stash: &mut Stash<M, P>) {
        if stash.len() <= batch_size {
            // append to the stash
            self.send_stashed(message, prio, stash);
        } else {
            // try to send
            self.send(message, prio, stash);
        }
    }

pub fn capacity(&self) -> usize

Returns the number of messages the stash can hold without reallocating.

Trait Implementations

impl<M, P> Drop for Stash<'_, M, P>where
    M: Send,
    P: PartialOrd + Ord,

fn drop(&mut self)

Executes the destructor for this type.