Struct OwnedPermit

pub struct OwnedPermit<Lock = Spinlock>
where
    Lock: RawMutex,
{ /* private fields */ }

An owned RAII guard representing one or more permits acquired from a Semaphore.

When the OwnedPermit is dropped, the permits it represents are released back to the Semaphore, potentially waking another task.

This type is identical to the Permit type, except that it holds an Arc clone of the Semaphore, rather than borrowing it. This allows the guard to be valid for the 'static lifetime.

This type is returned by the Semaphore::acquire_owned and Semaphore::try_acquire_owned methods.

Implementations

impl<Lock> OwnedPermit<Lock>

where Lock: RawMutex,

pub fn forget(self)

Forget this permit, dropping it without returning the number of acquired permits to the semaphore.

This permanently decreases the number of permits in the semaphore by self.permits().

pub fn permits(&self) -> usize

Returns the count of semaphore permits owned by this OwnedPermit.

Trait Implementations

impl<Lock> Debug for OwnedPermit<Lock>

where Lock: Debug + RawMutex,

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

Formats the value using the given formatter.

impl<Lock> Drop for OwnedPermit<Lock>

where Lock: RawMutex,

fn drop(&mut self)

Executes the destructor for this type.