Struct Consumer

Source

pub struct Consumer<T, const N: usize> { /* private fields */ }

Expand description

Consumer half of the ring buffer

环形缓冲区的消费者端

§Type Parameters

T: Element type
N: Stack capacity threshold

§类型参数

T: 元素类型
N: 栈容量阈值

Implementations§

Source §

impl<T, const N: usize> Consumer<T, N>

Source

pub fn pop(&mut self) -> Result<T, PopError>

Pop a value from the buffer

从缓冲区弹出一个值

§Errors

Returns PopError::Empty if the buffer is empty

§错误

如果缓冲区空则返回 PopError::Empty

Source

pub fn is_empty(&self) -> bool

Check if the buffer is empty

检查缓冲区是否为空

Source

pub fn slots(&self) -> usize

Get the number of elements currently in the buffer

获取缓冲区中当前的元素数量

Source

pub fn len(&self) -> usize

Get the number of elements currently in the buffer (alias for slots)

获取缓冲区中当前的元素数量（slots 的别名）

Source

pub fn capacity(&self) -> usize

Get the capacity of the buffer

获取缓冲区容量

Source

pub fn peek(&self) -> Option<&T>

Peek at the first element without removing it

查看第一个元素但不移除它

§Returns

Some(&T) if there is an element, None if the buffer is empty

§返回值

如果有元素则返回 Some(&T)，如果缓冲区为空则返回 None

§Safety

The returned reference is valid only as long as no other operations are performed on the Consumer that might modify the buffer.

§安全性

返回的引用仅在未对 Consumer 执行可能修改缓冲区的其他操作时有效。

Source

pub fn clear(&mut self)

Clear all elements from the buffer

清空缓冲区中的所有元素

This method pops and drops all elements currently in the buffer.

此方法弹出并 drop 缓冲区中当前的所有元素。

Source

pub fn drain(&mut self) -> Drain<'_, T, N> ⓘ

Create a draining iterator

创建一个消费迭代器

Returns an iterator that removes and returns elements from the buffer. The iterator will continue until the buffer is empty.

返回一个从缓冲区中移除并返回元素的迭代器。迭代器将持续运行直到缓冲区为空。

§Examples

use smallring::spsc::new;
use std::num::NonZero;

let (mut producer, mut consumer) = new::<i32, 32>(NonZero::new(8).unwrap());
producer.push(1).unwrap();
producer.push(2).unwrap();
producer.push(3).unwrap();

let items: Vec<i32> = consumer.drain().collect();
assert_eq!(items, vec![1, 2, 3]);
assert!(consumer.is_empty());