thingbuf

"我在缓冲池。我在MPSC通道。我在MPSC通道和缓冲池的组合体。"

这是什么？

thingbuf是一个基于数组的无锁并发环形缓冲区，允许通过引用访问缓冲区中的槽位。它还包括使用该环形缓冲区实现的异步和阻塞有界MPSC通道。

如果你想要一个高吞吐量的有界MPSC通道，只在通道创建时分配内存。一些MPSC通道具有良好的吞吐量。另一些MPSC通道不会为每个等待者分配内存。thingbuf::mpsc兼具这两个特点。在大多数用例中，thingbuf::mpsc是一个具有竞争力的通用MPSC通道选择。

提供了异步和阻塞两种MPSC通道，因此thingbuf可以替代像futures::channel::mpsc这样的异步通道以及像std::sync::mpsc::sync_channel这样的阻塞通道。
如果你无法分配内存或需要使用#![no_std]构建，因为你正在进行嵌入式系统或其他裸机软件开发。Thingbuf提供了一个静态分配的MPSC通道和一个静态分配的无锁队列。这些可以放在static初始化器中，无需任何运行时分配即可使用。
你想在有和没有std的情况下使用相同的MPSC通道。无论是否启用"std"特性标志，Thingbuf的异步MPSC通道都提供相同的API和功能集。如果你正在编写一个需要有条件地支持#![no_std]的库，并且需要一个异步MPSC通道，在两种情况下使用thingbuf::mpsc可能比在std和#![no_std]通道实现之间切换更容易。

讨论何时不应该使用thingbuf同样重要。以下是一些你可能更适合考虑其他选择的情况：

你需要一个非常、非常、荒谬地高的边界，而且大多数时候都不会接近它。如果你想为有界MPSC通道设置一个非常高的边界，而通道通常永远不会接近那么满，thingbuf::mpsc可能不是最佳选择。

Thingbuf的通道在构造时就会分配一个长度等于容量的数组。这通过避免额外的分配来提高性能，但如果你需要设置非常高的边界，你可能更喜欢只在需要时为消息分配内存的通道实现（比如tokio::sync::mpsc）。
你需要一个带有select操作的阻塞通道。我可能不会实现它。如果你提出，我可能会接受PR。

如果你需要具有这种功能的同步通道，crossbeam-channel可能是个不错的选择。
你想要一个无界通道。我不会写无界通道。无界通道是邪恶的。

本crate的API和文档区分了"队列"和"通道"这两个术语。术语队列指的是一般的[队列抽象数据类型][q-adt] —— 任何先进先出的数据结构都是队列。

术语通道指的是一种也作为同步原语的并发队列子类型。通道是一种可以在多个线程或异步任务之间共享的队列，允许这些线程或任务等待元素被添加到队列中或从队列中移除。

在Rust标准库中，[std::collections::VecDeque]类型是一个不是通道的队列的例子：它是一个先进先出的数据结构，但不能被多个线程或任务并发地入队和出队。相比之下，[std::sync::mpsc]模块中的类型提供了通道的典型例子，因为它们作为跨线程通信的同步原语。 [q-adt]: https://en.wikipedia.org/wiki/Queue_(abstract_data_type) [std::collections::VecDeque]: https://doc.rust-lang.org/stable/std/collections/struct.VecDeque.html [std::sync::mpsc]: https://doc.rust-lang.org/stable/std/sync/mpsc/index.html

要开始使用thingbuf，请在你的Cargo.toml中添加以下内容：

[dependencies]
thingbuf = "0.1"

默认情况下，thingbuf依赖于Rust标准库，以实现诸如同步（阻塞）通道等API。在#![no_std]项目中，必须禁用std特性标志：

[dependencies]
thingbuf = { version = "0.1", default-features = false }

禁用std特性后，thingbuf将仅依赖于libcore。这意味着需要动态内存分配的API将不可用。如果启用static特性标志，静态分配的通道和队列可用于没有内存分配器的代码：

[dependencies]
thingbuf = { version = "0.1", default-features = false, features = ["static"] }

然而，如果有可用的内存分配器，#![no_std]代码也可以启用alloc特性标志以依赖于liballoc：

[dependencies]
thingbuf = { version = "0.1", default-features = false, features = ["alloc"] }

std（默认启用）：启用需要Rust标准库的功能，如同步（阻塞）通道。这隐式启用了"alloc"特性标志。
alloc：启用需要liballoc（但不需要libstd）的功能。这使得可以使用运行时确定大小的thingbuf队列和异步通道。
static（默认禁用，需要Rust 1.59+）：启用静态（基于const泛型）thingbuf队列和通道。当队列或通道的大小在编译时已知时，可以在不进行动态内存分配的情况下使用这些功能。

thingbuf基于最新的稳定版本构建。最低支持版本是Rust 1.57。当前的thingbuf版本不保证能在早于最低支持版本的Rust版本上构建。

某些特性标志可能需要更新的Rust版本。例如，"static"特性标志需要Rust 1.60+。

问：为什么你要制作这个？

**答：**对于tracing，我想能够将格式化的日志行发送到专门的工作线程，由它将日志写入文件。目前，我们使用crossbeam-channel来实现这一点。然而，这有一个不幸的缺点，即我们必须分配String，通过通道将它们发送给写入器，然后立即丢弃它们。如果能重用这些分配就好了。因此...StringBuf诞生了。
问：它是无锁的吗？

**答：**非常无锁。
问：为什么只有有界变体？

**答：**因为无界队列是魔鬼的产物。
问：这不就是一个巨大的内存泄漏吗？

**答：**如果你使用不当，确实是。
问：为什么叫这个名字？

**答：**最初，我将其想象成一种环形缓冲区，所以（作为"ringbuf"的双关语）我称之为"stringbuf"。然后，我意识到你可以用它来处理不仅仅是字符串。事实上，它可以推广到任意...东西。所以，"thingbuf"。