4 个版本
| 0.1.0-rc.3 | 2024 年 2 月 11 日 |
|---|---|
| 0.1.0-rc.2 | 2023 年 8 月 31 日 |
| 0.1.0-rc.1 | 2023 年 8 月 21 日 |
| 0.1.0-rc.0 | 2023 年 6 月 13 日 |
在 并发 中排名 588
每月下载 761 次
在 flatty-io 中使用
155KB
4K SLoC
ringbuf
具有直接访问内部数据的无锁 SPSC FIFO 环形缓冲区。
特性
- 无锁操作 - 它们立即成功或失败，无需阻塞或等待。
- 任意项目类型（不仅仅是
Copy）。 - 项目可以逐个或一次多个插入和删除。
- 线程安全地直接访问内部环形缓冲区内存。
Read和Write实现。- 支持覆盖插入。
- 不同类型的缓冲区和底层存储。
- 可以在不使用
std的情况下使用，甚至不需要alloc（仅使用静态分配的内存）。 - 异步和阻塞版本（见 本节）。
用法
首先需要创建环形缓冲区本身。推荐使用 HeapRb，但你也可以 选择其他类型。
创建环形缓冲区后，它可以拆分为一对 Producer 和 Consumer。生产者用于向环形缓冲区插入项目，消费者用于从中删除项目。
类型
提供了几种环形缓冲区类型
LocalRb。仅适用于单线程使用。SharedRb。可以在线程之间共享。其常用实例HeapRb。内容存储在动态内存中。推荐在大多数情况下使用。StaticRb。内容可以存储在静态分配的内存中。
您也可以提供自己的泛型参数。
性能
SharedRb 需要在 CPU 核心之间同步 CPU 缓存。这种同步有一些开销。为了避免不必要的多次同步，您可以使用一次操作多个项目的方 法（push_slice/push_iter、pop_slice/pop_iter 等），或者您可以冻结生产者或消费者，然后手动同步线程（请参阅 frozen 模块中的条目）。
对于单线程使用，推荐使用 LocalRb，因为它比 SharedRb 略快，因为没有CPU缓存同步。
示例
简单
use ringbuf::{traits::*, HeapRb};
let rb = HeapRb::<i32>::new(2);
let (mut prod, mut cons) = rb.split();
prod.try_push(0).unwrap();
prod.try_push(1).unwrap();
assert_eq!(prod.try_push(2), Err(2));
assert_eq!(cons.try_pop(), Some(0));
prod.try_push(2).unwrap();
assert_eq!(cons.try_pop(), Some(1));
assert_eq!(cons.try_pop(), Some(2));
assert_eq!(cons.try_pop(), None);
无堆
use ringbuf::{traits::*, StaticRb};
const RB_SIZE: usize = 1;
let mut rb = StaticRb::<i32, RB_SIZE>::default();
let (mut prod, mut cons) = rb.split_ref();
assert_eq!(prod.try_push(123), Ok(()));
assert_eq!(prod.try_push(321), Err(321));
assert_eq!(cons.try_pop(), Some(123));
assert_eq!(cons.try_pop(), None);
覆盖
环形缓冲区可以在覆盖模式下使用，当缓冲区满时插入会覆盖最新的元素。
use ringbuf::{traits::*, HeapRb};
let mut rb = HeapRb::<i32>::new(2);
assert_eq!(rb.push_overwrite(0), None);
assert_eq!(rb.push_overwrite(1), None);
assert_eq!(rb.push_overwrite(2), Some(0));
assert_eq!(rb.try_pop(), Some(1));
assert_eq!(rb.try_pop(), Some(2));
assert_eq!(rb.try_pop(), None);
请注意，push_overwrite 需要对环形缓冲区进行独占访问，因此为了并发执行，您需要使用互斥锁或其他锁来保护环形缓冲区。
衍生crate
许可证
许可方式如下
- Apache许可证，版本2.0 (LICENSE-APACHE 或 http://www.apache.org/licenses/LICENSE-2.0)
- MIT许可证 (LICENSE-MIT 或 http://opensource.org/licenses/MIT)
任选其一。
贡献
除非您明确声明，否则任何有意提交以包含在您的工作中的贡献，根据Apache-2.0许可证的定义，将按上述方式双重许可，不附加任何额外条款或条件。
依赖项
~115KB