Skip to main content

Crate asyncband

Crate asyncband 

Source
Expand description

Composable, runtime-agnostic concurrency building blocks for async Rust.

asyncband provides synchronization, initialization, task coordination, channels, resource reuse, and workload control without choosing an executor for the application. Its async APIs use standard futures and wakers, so they can run on Tokio, async-std, smol, or a custom executor.

§Getting started

Public APIs are enabled through opt-in Cargo features, and no features are enabled by default. Enable the APIs your application needs:

asyncband = { version = "0.7", features = ["mutex", "oneshot"] }

Then use the selected APIs directly:

use asyncband::mutex::Mutex;

let counter = Mutex::new(0);
{
    let mut value = counter.lock().await;
    *value += 1;
}
assert_eq!(*counter.lock().await, 1);

§API map

AreaAPIFeatureUse
Locks and conditionsMutexmutexProtect shared data with asynchronous mutual exclusion.
RwLockrwlockAllow multiple readers or one writer.
CondvarcondvarWait for notifications while releasing a mutex.
CoordinationSemaphoresemaphoreLimit concurrent work by acquiring permits.
BarrierbarrierSynchronize a fixed number of participants at a reusable rendezvous.
ManualResetEventeventSignal current and future waits until explicitly reset.
LatchlatchWait until a fixed one-way countdown reaches zero.
WaitGroupwaitgroupDynamically register participants and wait until all have completed.
ShutdownshutdownRequest shutdown and wait until all completion guards are dropped.
Work coalescingOnceonceComplete one asynchronous initialization; cancelled or panicked attempts may be retried.
OnceCellonce-cellStore one value from an access-time initializer; failed, cancelled, or panicked attempts may be retried.
LazyCelllazy-cellInitialize one value with a stored function and resume the same in-flight future after caller cancellation.
OnceMaponce-mapCoalesce work per key and retain each successful value until explicitly removed.
GroupsingleflightCoalesce overlapping work per key without retaining completed values.
CommunicationCompletioncompletionPublish one shared result to any number of current and future observers.
[oneshot]oneshotSend one value from one sender to one receiver.
[mpsc]mpscSend each value from multiple producers to one receiver with bounded backpressure or an unbounded queue.
[broadcast]broadcastDeliver every value to receivers active at send time; retain an unbounded backlog until each consumes or drops.
[watch]watchPublish cloneable latest state from one or more senders; receivers independently coalesce intermediate updates.
Object reuse[pool]poolReuse objects through bounded or unbounded pool variants.
Sync interopFutureExtblockingDrive one runtime-agnostic future from a blocking thread.

§Scope and runtime model

The project is not limited to small or stateless primitives. Stateful tools such as [singleflight::Group] and the [pool] module fit when they provide reusable coordination and remain independent of executor policy.

The async APIs do not start threads, spawn tasks, install timers, or require a runtime-specific reactor. Task placement, deadlines, retries, periodic maintenance, and lifecycle orchestration remain with the caller. Await Asyncband futures inside any executor that polls standard Rust futures, and compose those runtime services around them.

§Async first, blocking by adaptation

Async and synchronous primitives have different optimization constraints. Asyncband designs its primitives for async use and provides the optional [blocking] module as a boundary adapter instead of duplicating synchronous methods across every type. Sync-first implementations can exploit OS- or platform-specific facilities and remain the domain of dedicated libraries.

The adapter polls one future on the calling thread. It is not a general-purpose async runtime, and futures that depend on a runtime-specific timer or I/O driver may not make progress. See the module documentation for the full execution constraints.

§Thread safety

Asyncband types implement Send and Sync only when their protected, transferred, or managed values satisfy the required bounds. Consult each API’s documentation for its exact contract.

§Disclaimer

Apache Asyncband (Incubating) is an effort undergoing incubation at the Apache Software Foundation (ASF), sponsored by the Apache Incubator PMC.

Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision-making process have stabilized in a manner consistent with other successful ASF projects.

While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.

Modules§

mutex
Mutual exclusion that yields the current task while waiting.