Skip to main content

RingBuffer

Struct RingBuffer 

Source
pub struct RingBuffer<T, const N: usize>
where T: Transcendental,
{ /* private fields */ }
Expand description

Кольцевой буфер с фиксированным размером

§Пример

use rill_core::buffer::RingBuffer;

let mut buffer = RingBuffer::<f32, 4>::new();
buffer.write(1.0);
buffer.write(2.0);
buffer.write(3.0);
buffer.write(4.0);

assert_eq!(buffer.read_delayed(0), 4.0); // последний записанный
assert_eq!(buffer.read_delayed(1), 3.0);
assert_eq!(buffer.read_delayed(2), 2.0);
assert_eq!(buffer.read_delayed(3), 1.0);

Implementations§

Source§

impl<T, const N: usize> RingBuffer<T, N>
where T: Transcendental,

Source

pub fn new() -> RingBuffer<T, N>

Создать новый кольцевой буфер

§Panics

Паникует, если N не является степенью двойки

Source

pub fn write(&mut self, sample: T)

Записать семпл (всегда успешно, перезаписывает старые данные)

§Safety

Эта операция безопасна, потому что:

  1. head уникален для производителя
  2. Производитель никогда не читает из своей позиции
  3. Атомарные операции гарантируют видимость
Source

pub fn write_slice(&mut self, samples: &[T])

Записать массив семплов

Source

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

Прочитать семпл (если есть)

§Returns
  • Some(sample) - семпл успешно прочитан
  • None - буфер пуст
Source

pub fn read_delayed(&self, delay: usize) -> T

Прочитать семпл с задержкой (без изменения указателей)

§Arguments
  • delay - задержка в семплах (0 = последний записанный)
§Panics

Паникует, если delay >= len()

Source

pub fn read_interpolated(&self, delay_frac: f32) -> T
where T: From<f32> + Into<f32>,

Прочитать с интерполяцией (для дробных задержек)

§Arguments
  • delay_frac - задержка в семплах с дробной частью
§Returns

Интерполированное значение (линейная интерполяция)

Source

pub fn read_sequence_interpolated(&self, start_delay: f32, output: &mut [T])
where T: From<f32> + Into<f32>,

Прочитать последовательность с интерполяцией

§Arguments
  • start_delay - начальная задержка
  • output - буфер для записи результата
Source

pub fn len(&self) -> usize

Текущий размер (количество элементов в буфере)

Source

pub const fn capacity(&self) -> usize

Вместимость буфера

Source

pub fn is_empty(&self) -> bool

Проверить, пуст ли буфер

Source

pub fn is_full(&self) -> bool

Проверить, полон ли буфер

Source

pub fn clear(&mut self)

Очистить буфер (сбросить указатели)

Source

pub fn reset(&mut self)

Сбросить буфер без обнуления данных (быстрее)

Source§

impl<T, const N: usize> RingBuffer<T, N>
where T: Transcendental,

Source

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

Получить итератор по элементам буфера (от самого старого к самому новому)

Trait Implementations§

Source§

impl<T, const N: usize> Debug for RingBuffer<T, N>
where T: Transcendental + Debug,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T, const N: usize> Default for RingBuffer<T, N>
where T: Transcendental,

Source§

fn default() -> RingBuffer<T, N>

Returns the “default value” for a type. Read more
Source§

impl<T, const N: usize> Send for RingBuffer<T, N>
where T: Transcendental + Send,

Source§

impl<T, const N: usize> Sync for RingBuffer<T, N>
where T: Transcendental + Sync,

Auto Trait Implementations§

§

impl<T, const N: usize> !Freeze for RingBuffer<T, N>

§

impl<T, const N: usize> !RefUnwindSafe for RingBuffer<T, N>

§

impl<T, const N: usize> Unpin for RingBuffer<T, N>
where T: Unpin,

§

impl<T, const N: usize> UnsafeUnpin for RingBuffer<T, N>
where T: UnsafeUnpin,

§

impl<T, const N: usize> UnwindSafe for RingBuffer<T, N>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> AsAny for T
where T: 'static,

Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert to &dyn std::any::Any
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert to &mut dyn std::any::Any
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V