async-bulkhead 0.1.0

An async semaphore-based bulkhead implementation
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

//! An async semaphore-based bulkhead implementation.
//!
//! The [`Bulkhead`] struct provides a `limit` method for wrapping
//! futures with the bulkhead client-side resiliency pattern.
//!
//! ### Example
//! ```rust
//! use async_bulkhead::Bulkhead;
//! use async_bulkhead::BulkheadError;
//! use std::time::Duration;
//!
//! let bulkhead = Bulkhead::builder()
//!     .max_concurrent_calls(10)
//!     .max_wait_duration(Duration::from_millis(100))
//!     .build()
//!     .expect("max concurrent calls not > 0");
//!
//! async {
//!     let value = bulkhead.limit(async { 10 }).await?;
//!     println!("{value}");
//!     Ok::<_, BulkheadError>(())
//! };
//! ```
//!
//! ### Features
//! Note that the runtime features of this crate are mutually exclusive.
//! You should only use one of the following:
//! 1. `rt-tokio` (default)
//! 1. `rt-async-std`
//! 1. `rt-smol`

mod bulkhead;
pub use bulkhead::*;