Struct lilos::spsc::Permit

pub struct Permit<'q, T> { /* private fields */ }

A “permit” giving its holder the right to push one element into a queue, without waiting.

This is produced by Push::try_reserve/Push::reserve when they find space available in the queue. The key property here is that producing a Permit does not, by itself, change the queue state – you can turn around and Drop the Permit without losing data or pushing anything. This makes cancel safety much easier to reason about.

Implementations

impl<T> Permit<'_, T>

pub fn push(self, value: T)

Pushes value to the queue, consuming this Permit.

The push operation is guaranteed to succeed synchronously, since holding a Permit is proof that the next cell at the head of the queue is available for use.

Trait Implementations

impl<'q, T: Debug> Debug for Permit<'q, T>

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

Formats the value using the given formatter.