priority-semaphore 0.2.0

Runtime-agnostic priority-aware async semaphore for Rust.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

#![cfg_attr(not(feature = "std"), no_std)]
#![forbid(unsafe_code)]
#![deny(missing_docs)]

//! Runtime-agnostic priority semaphore.
//!
//! This crate provides [`PrioritySemaphore`], an asynchronous semaphore where
//! waiters supply a signed priority. Higher priorities are granted returned
//! permits before lower ones, and equal priorities use FIFO order. The
//! implementation uses only the standard `Future`/`Waker` contract and does
//! not depend on a particular async runtime.
//!
//! ```rust
//! use std::sync::Arc;
//! use priority_semaphore::PrioritySemaphore;
//!
//! # #[tokio::main]
//! # async fn main() {
//! let semaphore = Arc::new(PrioritySemaphore::new(4));
//! let permit = semaphore.acquire(10).await.unwrap();
//! // The permit is returned automatically, including during unwinding.
//! drop(permit);
//! # }
//! ```

extern crate alloc;
#[cfg(feature = "std")]
extern crate std;

mod error;
mod lock;
mod permit;
mod queue;
mod semaphore;
mod util;
mod waiter;

pub use crate::error::{AcquireError, TryAcquireError};
pub use crate::permit::Permit;
pub use crate::semaphore::{Priority, PrioritySemaphore};
pub use crate::waiter::AcquireFuture;