Skip to main content

Semaphore

Struct Semaphore 

Source
pub struct Semaphore { /* private fields */ }
Expand description

A counting semaphore: .acquire().await waits (without blocking the OS thread) until a permit is available, then holds it until the returned SemaphorePermit is dropped.

Implementations§

Source§

impl Semaphore

Source

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

Create a semaphore with permits available immediately.

Source

pub fn available_permits(&self) -> usize

Current number of permits available for immediate acquisition.

Source

pub fn add_permits(&self, n: usize)

Add n permits, waking waiters as needed.

Source

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

Acquire one permit, waiting if none are currently available.

Source

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

Acquire one permit if immediately available, without waiting.

§Errors

Returns TryAcquireError::NoPermits if none are currently free.

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Error = Infallible

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

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

Performs the conversion.
Source§

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

Source§

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

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

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

Performs the conversion.