Struct SemaphorePermit 

pub struct SemaphorePermit<'a> { /* private fields */ }

Permits taken from a Semaphore, returned when dropped.

The release is one atomic read-modify-write when no waiter needs telling. Otherwise it is lock-free, not wait-free: it returns after one pass over the queue, plus at most one for each operation of another thread that lands on the queue meanwhile (see Progress).

Implementations

impl<'a> SemaphorePermit<'a>

pub fn forget(self)

Keeps the permits out of the semaphore for good.

pub fn merge(&mut self, other: Self)

Merges other into this permit, so one drop returns both.

Panics

When the permits come from different semaphores, or their total overflows usize.

pub fn split(&mut self, n: usize) -> Option<Self>

Splits n permits off this one, or returns None when it holds fewer than n.

pub fn semaphore(&self) -> &'a Semaphore

The semaphore these permits came from.

pub fn num_permits(&self) -> usize

How many permits this holds.

pub fn count(&self) -> usize

How many permits this holds; the same as num_permits.

Trait Implementations

impl Debug for SemaphorePermit<'_>

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

Formats the value using the given formatter.

impl Drop for SemaphorePermit<'_>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.