Struct Semaphore 

pub struct Semaphore { /* private fields */ }

A semaphore maintains a set of permits. Permits are used to synchronize access to a shared resource. A semaphore differs from a mutex in that it can allow more than one concurrent caller to access the shared resource at a time.

Implementations

impl Semaphore

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

Creates a new instance of Semaphore with the given permits count.

This is typically used to create a static semaphore:

use hydra::Semaphore;

static RATE_LIMIT: Semaphore = Semaphore::new(100);

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

Acquires one permit asynchronously waiting for one to become available.

pub async fn acquire_many(&self, count: u32) -> SemaphorePermit<'_>

Acquires many permits asynchronously waiting for them to become available.

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

Attempts to acquire a permit, returning an error if there are none available.