Struct tokio::sync::SemaphorePermit

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

Available on crate feature sync only.

A permit from the semaphore.

This type is created by the acquire method.

Implementations

impl<'a> SemaphorePermit<'a>

pub fn forget(self)

Forgets the permit without releasing it back to the semaphore. This can be used to reduce the amount of permits available from a semaphore.

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

Merge two SemaphorePermit instances together, consuming other without releasing the permits it holds.

Permits held by both self and other are released when self drops.

Panics

This function panics if permits from different Semaphore instances are merged.

Trait Implementations

impl<'a> Debug for SemaphorePermit<'a>

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.