Struct FrodoRing 

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

Кольцевая очередь с порядком FIFO и не использующая аллокации.

У данной кольцевой очереди следующие ключевые особенности:

• два API: привычный (get/len/iter/remove с небольшим оверхедом O(n) на возможный поиск) и местный (at/used/remove_at)
• элементы могут быть изъяты из середины очереди без перемещения объектов в памяти, пока не достигнута максимальная ёмкость очереди
• смысл очереди - иметь возможность найти элемент с нужными предикатами, отсортированный в порядке очереди, в no_std-окружении.

Implementations

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

pub fn new() -> Self

Создаёт новую кольцевую очередь.

pub fn used(&self) -> usize

Возвращает использованное число ячеек кольцевой очереди.

pub fn len(&self) -> usize

Возвращает число элементов, находящихся в очереди.

pub fn is_empty(&self) -> bool

Сообщает, есть ли в очереди элементы.

pub fn at(&self, naive_pos: isize) -> Option<&T>

Получает элемент по ячейке (наивной позиции).

Примеры:

• ring.at(0) - получить первый элемент в очереди
• ring.at(1) - получить содержимое ячейки следом за первым элементом (ячейка может быть пустой)
• ring.at(ring.used() - 1) - получить последний элемент в очереди
• ring.at(-1) - также получить последний элемент в очереди

pub fn get(&self, pos: usize) -> Option<&T>

Получает элемент по очереди.

Примеры:

• ring.get(0) - получить первый элемент в очереди
• ring.get(1) - получить второй элемент в очереди
• ring.get(ring.len() - 1) - получить последний элемент в очереди

pub fn iter(&self) -> FrodoRingIterator<'_, T, N>

Создаёт итератор по очереди.

pub fn position<F: Fn(&T) -> bool>(&self, f: F) -> Option<isize>

Получает наивную позицию (ячейку) элемента, отвечающего условию.

Чтобы получить сам элемент, используйте ring.at(naive_pos).

pub fn push(&mut self, item: T) -> Result<(), T>

Кладёт элемент в очередь.

В случае, если число использованных очередью ячеек равно N, но при этом хотя бы одна из них не занята, очередь проводит операцию сжатия (O(n)) с перемещением элементов в памяти.

pub fn pick(&mut self) -> Option<T>

Отдаёт первый элемент, изымая его из очереди.

pub fn remove_at(&mut self, naive_pos: isize) -> Option<T>

Удаляет содержимое ячейки, находящейся по наивной позиции, и возвращает его.

pub fn remove(&mut self, pos: usize) -> Option<T>

Удаляет элемент из очереди.

Trait Implementations

impl<T: Debug, const N: usize> Debug for FrodoRing<T, N>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T, const N: usize> Default for FrodoRing<T, N>

fn default() -> Self

Returns the “default value” for a type.