async-fifo 0.6.5

MPMC & oneshot channels with (a)sync API
Documentation 
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

//! Channels based on [`crate::fifo`]
//!
//! # Example
//!
//! ```rust
//! # use async_fifo::{block_on, Closed};
//! # block_on(async {
//! let (tx, mut rx) = async_fifo::new();
//! tx.send_iter(['a', 'b', 'c']);
//!
//! // Receive one by one
//! assert_eq!(rx.recv().await, Ok('a'));
//! assert_eq!(rx.recv().await, Ok('b'));
//! assert_eq!(rx.recv().await, Ok('c'));
//!
//! core::mem::drop(tx);
//! assert_eq!(rx.recv().await, Err(Closed));
//! # });
//! ```

use crate::fifo::DefaultBlockSize;

pub mod non_blocking;
mod subscription;
mod async_api;
mod future;

pub use async_api::*;
pub use future::*;

#[doc(inline)]
pub use oneshot::new as oneshot;

#[cfg(feature = "blocking")]
mod blocking;

#[cfg(feature = "async-read")]
mod async_read;

pub mod oneshot;

/// Creates a channel with the default block size
pub fn new<T: 'static>() -> (Sender<T>, Receiver<T>) {
    DefaultBlockSize::channel()
}