Struct async_lock::Semaphore

pub struct Semaphore { /* private fields */ }

A counter for limiting the number of concurrent operations.

Implementations

impl Semaphore

pub const fn new(n: usize) -> Semaphore

Creates a new semaphore with a limit of n concurrent operations.

Examples

use async_lock::Semaphore;

let s = Semaphore::new(5);

pub fn try_acquire(&self) -> Option<SemaphoreGuard<'_>>

Attempts to get a permit for a concurrent operation.

If the permit could not be acquired at this time, then None is returned. Otherwise, a guard is returned that releases the mutex when dropped.

Examples

use async_lock::Semaphore;

let s = Semaphore::new(2);

let g1 = s.try_acquire().unwrap();
let g2 = s.try_acquire().unwrap();

assert!(s.try_acquire().is_none());
drop(g2);
assert!(s.try_acquire().is_some());

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

Waits for a permit for a concurrent operation.

Returns a guard that releases the permit when dropped.

Examples

use async_lock::Semaphore;

let s = Semaphore::new(2);
let guard = s.acquire().await;

impl Semaphore

pub fn try_acquire_arc(self: &Arc<Self>) -> Option<SemaphoreGuardArc>

Attempts to get an owned permit for a concurrent operation.

If the permit could not be acquired at this time, then None is returned. Otherwise, an owned guard is returned that releases the mutex when dropped.

Examples

use async_lock::Semaphore;
use std::sync::Arc;

let s = Arc::new(Semaphore::new(2));

let g1 = s.try_acquire_arc().unwrap();
let g2 = s.try_acquire_arc().unwrap();

assert!(s.try_acquire_arc().is_none());
drop(g2);
assert!(s.try_acquire_arc().is_some());

pub fn acquire_arc(self: &Arc<Self>) -> impl Future<Output = SemaphoreGuardArc>

Waits for an owned permit for a concurrent operation.

Returns a guard that releases the permit when dropped.

Examples

use async_lock::Semaphore;
use std::sync::Arc;

let s = Arc::new(Semaphore::new(2));
let guard = s.acquire_arc().await;

Trait Implementations

impl Debug for Semaphore

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

Formats the value using the given formatter.