Struct futures_intrusive::sync::GenericSharedSemaphore

pub struct GenericSharedSemaphore<MutexType: RawMutex> { /* private fields */ }

A futures-aware shared semaphore.

Implementations

impl<MutexType: RawMutex> GenericSharedSemaphore<MutexType>

pub fn new(is_fair: bool, permits: usize) -> GenericSharedSemaphore<MutexType>

Creates a new futures-aware shared semaphore.

See GenericSharedSemaphore for more information.

pub fn acquire(
    &self,
    nr_permits: usize
) -> GenericSharedSemaphoreAcquireFuture<MutexType>

Acquire a certain amount of permits on a semaphore asynchronously.

This method returns a future that will resolve once the given amount of permits have been acquired. The Future will resolve to a GenericSharedSemaphoreReleaser, which will release all acquired permits automatically when dropped.

pub fn try_acquire(
    &self,
    nr_permits: usize
) -> Option<GenericSharedSemaphoreReleaser<MutexType>>

Tries to acquire a certain amount of permits on a semaphore.

If acquiring the permits is successful, a GenericSharedSemaphoreReleaser will be returned, which will release all acquired permits automatically when dropped.

Otherwise None will be returned.

pub fn release(&self, nr_permits: usize)

Releases the given amount of permits back to the semaphore.

This method should in most cases not be used, since the GenericSharedSemaphoreReleaser which is obtained when acquiring a Semaphore will automatically release the obtained permits again.

Therefore this method should only be used if the automatic release was disabled by calling GenericSharedSemaphoreReleaser::disarm, or when the amount of permits in the Semaphore should increase from the initial amount.

pub fn permits(&self) -> usize

Returns the amount of permits that are available on the semaphore

Trait Implementations

impl<MutexType: RawMutex> Clone for GenericSharedSemaphore<MutexType>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<MutexType: RawMutex> Debug for GenericSharedSemaphore<MutexType>

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

Formats the value using the given formatter.

impl<MutexType: RawMutex + Send + Sync> Send for GenericSharedSemaphore<MutexType>

impl<MutexType: RawMutex + Sync> Sync for GenericSharedSemaphore<MutexType>