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 42 43 44 45 46 47 48 49 50 51
|
# async-channel
[](
https://github.com/smol-rs/async-channel/actions)
[](
https://github.com/smol-rs/async-channel)
[](
https://crates.io/crates/async-channel)
[](
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.
|