Struct embassy_sync::semaphore::FairSemaphore

source ·
pub struct FairSemaphore<M, const N: usize>
where M: RawMutex,
{ /* private fields */ }
Expand description

A fair Semaphore implementation.

Tasks are allowed to acquire permits in FIFO order. A task waiting to acquire a large number of permits will prevent other tasks from acquiring any permits until its request is satisfied.

Up to N tasks may attempt to acquire permits concurrently. If additional tasks attempt to acquire a permit, a WaitQueueFull error will be returned.

Implementations§

source§

impl<M, const N: usize> FairSemaphore<M, N>
where M: RawMutex,

source

pub const fn new(permits: usize) -> Self

Create a new FairSemaphore.

Trait Implementations§

source§

impl<M, const N: usize> Default for FairSemaphore<M, N>
where M: RawMutex,

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl<M: RawMutex, const N: usize> Semaphore for FairSemaphore<M, N>

§

type Error = WaitQueueFull

The error returned when the semaphore is unable to acquire the requested permits.
source§

fn acquire( &self, permits: usize, ) -> impl Future<Output = Result<SemaphoreReleaser<'_, Self>, Self::Error>>

Asynchronously acquire one or more permits from the semaphore.
source§

fn try_acquire(&self, permits: usize) -> Option<SemaphoreReleaser<'_, Self>>

Try to immediately acquire one or more permits from the semaphore.
source§

fn acquire_all( &self, min: usize, ) -> impl Future<Output = Result<SemaphoreReleaser<'_, Self>, Self::Error>>

Asynchronously acquire all permits controlled by the semaphore. Read more
source§

fn try_acquire_all(&self, min: usize) -> Option<SemaphoreReleaser<'_, Self>>

Try to immediately acquire all available permits from the semaphore, if at least min permits are available.
source§

fn release(&self, permits: usize)

Release permits back to the semaphore, making them available to be acquired.
source§

fn set(&self, permits: usize)

Reset the number of available permints in the semaphore to permits.

Auto Trait Implementations§

§

impl<M, const N: usize> !Freeze for FairSemaphore<M, N>

§

impl<M, const N: usize> !RefUnwindSafe for FairSemaphore<M, N>

§

impl<M, const N: usize> Send for FairSemaphore<M, N>
where M: Send,

§

impl<M, const N: usize> Sync for FairSemaphore<M, N>
where M: Sync,

§

impl<M, const N: usize> Unpin for FairSemaphore<M, N>
where M: Unpin,

§

impl<M, const N: usize> UnwindSafe for FairSemaphore<M, N>
where M: UnwindSafe,

Blanket Implementations§

§

impl<T> Any for T
where T: 'static + ?Sized,

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> Borrow<T> for T
where T: ?Sized,

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

impl<T> BorrowMut<T> for T
where T: ?Sized,

§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, U> Into<U> for T
where U: From<T>,

§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.