Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zesterer/flume
A safe and fast multi-producer, multi-consumer channel.
https://github.com/zesterer/flume
channel concurrency rust
Last synced: about 10 hours ago
JSON representation
A safe and fast multi-producer, multi-consumer channel.
- Host: GitHub
- URL: https://github.com/zesterer/flume
- Owner: zesterer
- License: apache-2.0
- Created: 2019-07-30T15:58:22.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-19T13:54:15.000Z (2 months ago)
- Last Synced: 2024-12-23T19:05:10.659Z (7 days ago)
- Topics: channel, concurrency, rust
- Language: Rust
- Homepage: https://crates.io/crates/flume
- Size: 609 KB
- Stars: 2,483
- Watchers: 23
- Forks: 86
- Open Issues: 32
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE-APACHE
Awesome Lists containing this project
- awesome-rust-list - Flume - producer, multi-consumer channel. [crates.io/crates/flume](https://crates.io/crates/flume) (Parallel and Async Library)
- awesome-rust-list - Flume - producer, multi-consumer channel. [crates.io/crates/flume](https://crates.io/crates/flume) (Parallel and Async Library)
README
# Flume
A blazingly fast multi-producer, multi-consumer channel.
[](
https://crates.io/crates/flume)
[](
https://docs.rs/flume)
[](
https://github.com/zesterer/flume)
[](https://casuallymaintained.tech/)
```rust
use std::thread;
fn main() {
println!("Hello, world!");
let (tx, rx) = flume::unbounded();
thread::spawn(move || {
(0..10).for_each(|i| {
tx.send(i).unwrap();
})
});
let received: u32 = rx.iter().sum();
assert_eq!((0..10).sum::(), received);
}
```
## Why Flume?
- **Featureful**: Unbounded, bounded and rendezvous queues
- **Fast**: Always faster than `std::sync::mpsc` and sometimes `crossbeam-channel`
- **Safe**: No `unsafe` code anywhere in the codebase!
- **Flexible**: `Sender` and `Receiver` both implement `Send + Sync + Clone`
- **Familiar**: Drop-in replacement for `std::sync::mpsc`
- **Capable**: Additional features like MPMC support and send timeouts/deadlines
- **Simple**: Few dependencies, minimal codebase, fast to compile
- **Asynchronous**: `async` support, including mix 'n match with sync code
- **Ergonomic**: Powerful `select`-like interface
## Usage
To use Flume, place the following line under the `[dependencies]` section in your `Cargo.toml`:
```toml
flume = "x.y"
```
## Cargo Features
Flume comes with several optional features:
- `spin`: use spinlocks instead of OS-level synchronisation primitives internally for some kind of data access (may be more performant on a small number of platforms for specific workloads)
- `select`: Adds support for the [`Selector`](https://docs.rs/flume/latest/flume/select/struct.Selector.html) API, allowing a thread to wait on several channels/operations at once
- `async`: Adds support for the [async API](https://docs.rs/flume/latest/flume/async/index.html), including on otherwise synchronous channels
- `eventual-fairness`: Use randomness in the implementation of `Selector` to avoid biasing/saturating certain events over others
You can enable these features by changing the dependency in your `Cargo.toml` like so:
```toml
flume = { version = "x.y", default-features = false, features = ["async", "select"] }
```
## [Benchmarks](https://what-if.xkcd.com/147/)
Although Flume has its own extensive benchmarks, don't take it from here that Flume is quick.
The following graph is from the `crossbeam-channel` benchmark suite.
Tests were performed on an AMD Ryzen 7 3700x with 8/16 cores running Linux kernel 5.11.2 with the bfq scheduler.
# 
## Status
Flume is in [casual maintenance mode](https://casuallymaintained.tech/). This means that the crate will continue to
receive critical security and bug fixes, but heavy feature development has stopped. If you're looking for a new
feature, you're welcome to open a PR and I'll try to find the time to review it.
Flume has been great fun to work on, and I'm happy that it's being used successfully by so many people. I consider the
crate to be largely feature-complete at this point (bar small details here and there).
## License
Flume is licensed under either of:
- Apache License 2.0, (http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (http://opensource.org/licenses/MIT)