async-channel

Crates.ioasync-channel
lib.rsasync-channel
version2.3.1
sourcesrc
created_at2019-05-06 13:07:43.086764
updated_at2024-05-16 01:34:44.810872
descriptionAsync multi-producer multi-consumer channel
homepage
repositoryhttps://github.com/smol-rs/async-channel
max_upload_size
id132389
size76,565
admins (github:smol-rs:admins)

documentation

README

async-channel

Build License Cargo Documentation

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 Senders or all Receivers 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

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

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.

Commit count: 111

cargo fmt