Cueue

Cueue 是一个高性能的、单生产者、单消费者、固定大小的循环缓冲区，支持无锁的原子批量操作，适合线程间通信。

示例

fn main() {
    let (mut w, mut r) = cueue::cueue(1 << 20).unwrap();

    let buf = w.write_chunk();
    assert!(buf.len() >= 9);
    buf[..9].copy_from_slice(b"foobarbaz");
    w.commit(9);

    let read_result = r.read_chunk();
    assert_eq!(read_result, b"foobarbaz");
    r.commit();
}

一个有固定容量的 cueue 由一个 Writer 和一个 Reader 引用。Writer 可以请求空间来写入（write_chunk），由队列容量减去已提交但未读的空间限制。请求到的空间可以被写入，然后提交（end_write）。这个容器的特殊之处在于存储的元素总是初始化的（一开始默认初始化，因此 T 必须实现 Default），并且在队列被丢弃时才被丢弃。因此，writer 可以重用之前写入但后来消费的元素（如果元素拥有堆分配的内存等，这很有用），在这些情况下，避免了生产者在堆锁上的竞争（否则如果消费者连续丢弃生产者分配的堆分配的元素，这种情况就会发生）。

Reader 可以检查写入的元素（read_chunk），随意处理，然后将其标记为已消费（commit）。返回的元素切片可能是多个 writer 提交的结果（即：读取是批量的），但它永远不会包含未提交的元素（即：写入提交是原子的）。这防止了 reader 观察到部分消息。

使用场景

这种数据结构旨在允许一个线程（actor）向不同的线程（actor）发送可变大小的消息（字节），而该线程以批量方式处理这些消息（例如：写入文件、通过网络发送等）。例如，异步日志。

替代方案

• 使用字符串的标准通道（或 Vec<u8>）。这很慢，因为字符串需要内存分配，并且由于一个线程分配而另一个线程释放，很快就会在堆锁上产生竞争。

• 使用固定大小数组的标准通道。这可行，但限制了消息的大小并浪费内存。

• 使用两个Vec<u8>容器（一个用于发送数据，一个用于重用已消耗的向量）。不允许高效读取（单独的消息不连续）。需要估计飞行中的最大消息数量，而不是消息最大总大小。

$ cargo build
$ cargo test
$ cargo run --example basics
$ cargo fmt
$ cargo clippy
$ cargo bench
$ cargo doc --open