Struct RankedSemaphore

pub struct RankedSemaphore { /* private fields */ }

High-performance priority semaphore

Implementations

impl RankedSemaphore

pub const MAX_PERMITS: usize = 2_305_843_009_213_693_951usize

Maximum permits (reserve 3 bits for flags, same as tokio)

pub fn new_fifo(permits: usize) -> Self

Create FIFO semaphore

pub fn new_lifo(permits: usize) -> Self

Create LIFO semaphore

pub fn new(permits: usize, default_strategy: QueueStrategy) -> Self

Create semaphore with specified strategy

pub fn new_with_config(permits: usize, config: PriorityConfig) -> Self

Create semaphore with custom configuration

pub fn available_permits(&self) -> usize

Get current available permits

pub fn is_closed(&self) -> bool

Check if semaphore is closed

pub fn add_permits(&self, added: usize)

Add permits and notify waiters if any.

pub fn close(&self)

Close semaphore and cancel all pending waiters.

pub fn acquire(&self) -> Acquire<'_>

Acquire with default priority

pub fn acquire_with_priority(&self, priority: isize) -> Acquire<'_>

Acquire with specified priority

pub fn acquire_many(&self, n: u32) -> Acquire<'_>

Acquire many permits (default priority)

pub fn acquire_many_with_priority(&self, priority: isize, n: u32) -> Acquire<'_>

Acquire many permits with priority

pub fn try_acquire(&self) -> Result<RankedSemaphorePermit<'_>, TryAcquireError>

Try acquire single permit (non-blocking)

pub fn try_acquire_many( &self, n: u32, ) -> Result<RankedSemaphorePermit<'_>, TryAcquireError>

Try acquire many permits (non-blocking)

pub fn forget_permits(&self, n: usize) -> usize

Forget (remove) permits from the semaphore

Returns the number of permits that were actually removed. If there are insufficient permits, removes as many as possible.

pub fn acquire_owned(self: Arc<Self>) -> AcquireOwned

Acquire owned permit (default priority)

pub fn acquire_owned_with_priority( self: Arc<Self>, priority: isize, ) -> AcquireOwned

Acquire owned permit with priority

pub fn acquire_many_owned(self: Arc<Self>, n: u32) -> AcquireOwned

Acquire many owned permits (default priority)

pub fn acquire_many_owned_with_priority( self: Arc<Self>, priority: isize, n: u32, ) -> AcquireOwned

Acquire many owned permits with priority

pub fn try_acquire_owned( self: Arc<Self>, ) -> Result<OwnedRankedSemaphorePermit, TryAcquireError>

Attempts to acquire a single permit, returning an owned permit if successful.

The semaphore must be wrapped in an Arc to call this method. If the semaphore has been closed, this returns a TryAcquireError::Closed and a TryAcquireError::NoPermits if there are no permits left. Otherwise, this returns an OwnedRankedSemaphorePermit representing the acquired permit.

pub fn try_acquire_many_owned( self: Arc<Self>, n: u32, ) -> Result<OwnedRankedSemaphorePermit, TryAcquireError>

Attempts to acquire n permits, returning an owned permit if successful.

The semaphore must be wrapped in an Arc to call this method. If the semaphore has been closed, this returns a TryAcquireError::Closed and a TryAcquireError::NoPermits if there are not enough permits left. Otherwise, this returns an OwnedRankedSemaphorePermit representing the acquired permit.

Trait Implementations

impl Debug for RankedSemaphore

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

Formats the value using the given formatter.