Struct OwnedSemaphorePermit

pub struct OwnedSemaphorePermit { /* private fields */ }

An owned permit from the semaphore.

This type is created by the acquire_owned method.

Implementations

impl OwnedSemaphorePermit

pub fn forget(self)

Forgets the permit without releasing it back to the semaphore.

This can be used to permanently reduce the number of permits available from a semaphore.

Examples

use std::sync::Arc;

use mea::semaphore::Semaphore;

let sem = Arc::new(Semaphore::new(10));
{
    let permit = sem.try_acquire(5).unwrap();
    assert_eq!(sem.available_permits(), 5);
    permit.forget();
}

// Since we forgot the permit, available permits won't go back to
// its initial value even after the permit is dropped
assert_eq!(sem.available_permits(), 5);

pub fn permits(&self) -> u32

Returns the number of permits this permit holds.

Examples

use mea::semaphore::Semaphore;

let sem = Semaphore::new(5);
let permit = sem.try_acquire(3).unwrap();
assert_eq!(permit.permits(), 3);

Trait Implementations

impl Debug for OwnedSemaphorePermit

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

Formats the value using the given formatter.

impl Drop for OwnedSemaphorePermit

fn drop(&mut self)

Executes the destructor for this type.