Struct Permit 

pub struct Permit<'a, S, C = Uncloseable>
where
    S: SemaphoreState + ?Sized,
    C: IsCloseable,
{ /* private fields */ }

The drop-guard for semaphore permits. Will ensure the permit is released when dropped.

Implementations

impl<'a, S, C> Permit<'a, S, C>

where S: SemaphoreState + ?Sized, C: IsCloseable,

pub fn out_of_thin_air(sem: &'a Semaphore<S, C>, permit: S::Permit) -> Self

Construct a new permit out of thin air, no waiting is required.

This can violate the purpose of the semaphore, but is provided for convenience. It can be used to introduce new permits to the semaphore if desired, or it can be paired with Permit::take for niche use-cases where the semaphore lifetime gets in the way.

pub fn semaphore(this: &Self) -> &'a Semaphore<S, C>

Get access to the associated semaphore

pub fn take(this: Self) -> S::Permit

Do not release the permit to the semaphore.

pub fn into_owned_permit(self, sem: Arc<Semaphore<S, C>>) -> OwnedPermit<S, C>

Upgrade this permit into an OwnedPermit.

Trait Implementations

impl<S, C> Debug for Permit<'_, S, C>

where S: SemaphoreState + ?Sized, C: IsCloseable, S::Permit: Debug,

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

Formats the value using the given formatter.

impl<S, C> Deref for Permit<'_, S, C>

where S: SemaphoreState + ?Sized, C: IsCloseable,

type Target = <S as SemaphoreState>::Permit

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<S, C> DerefMut for Permit<'_, S, C>

where S: SemaphoreState + ?Sized, C: IsCloseable,

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.