https://github.com/smol-rs/async-channel

Async multi-producer multi-consumer channel
https://github.com/smol-rs/async-channel

async rust

Last synced: 5 days ago
JSON representation

Async multi-producer multi-consumer channel

• Host: GitHub
• URL: https://github.com/smol-rs/async-channel
• Owner: smol-rs
• License: apache-2.0
• Created: 2020-05-31T00:00:08.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-10-19T22:32:53.000Z (23 days ago)
• Last Synced: 2024-11-01T16:04:02.537Z (10 days ago)
• Topics: async, rust
• Language: Rust
• Homepage:
• Size: 93.8 KB
• Stars: 778
• Watchers: 11
• Forks: 40
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
# async-channel

[![Build](https://github.com/smol-rs/async-channel/actions/workflows/ci.yml/badge.svg)](

https://github.com/smol-rs/async-channel/actions)

[![License](https://img.shields.io/badge/license-Apache--2.0_OR_MIT-blue.svg)](

https://github.com/smol-rs/async-channel)

[![Cargo](https://img.shields.io/crates/v/async-channel.svg)](

https://crates.io/crates/async-channel)

[![Documentation](https://docs.rs/async-channel/badge.svg)](

https://docs.rs/async-channel)

An async multi-producer multi-consumer channel, where each message can be received by only

one of all existing consumers.

There are two kinds of channels:

1. Bounded channel with limited capacity.

2. Unbounded channel with unlimited capacity.

A channel has the `Sender` and `Receiver` side. Both sides are cloneable and can be shared

among multiple threads.

When all `Sender`s or all `Receiver`s are dropped, the channel becomes closed. When a

channel is closed, no more messages can be sent, but remaining messages can still be received.

The channel can also be closed manually by calling `Sender::close()` or

`Receiver::close()`.

## Examples

```rust

let (s, r) = async_channel::unbounded();

assert_eq!(s.send("Hello").await, Ok(()));

assert_eq!(r.recv().await, Ok("Hello"));

```

## License

Licensed under either of

 * Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)

 * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

at your option.

#### Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted

for inclusion in the work by you, as defined in the Apache-2.0 license, shall be

dual licensed as above, without any additional terms or conditions.