Struct Buffer 

pub struct Buffer<T: Float> { /* private fields */ }

Single-channel delay buffer

Access is used with buffer[index], relative to the internal read/write position (“head”). This head is moved using buffer.advance(1) (or buffer.advance(n)), such that buffer[1] == buffer.advance(1)[0].

The capacity includes both positive and negative indices. For example, a capacity of 100 would support using any of the ranges:

• buffer[-99] to buffer[0]
• buffer[-50] to buffer[49]
• buffer[0] to buffer[99]

Although buffers are usually used with historical samples accessed using negative indices e.g. buffer[-10], you could equally use it flipped around (moving the head backwards through the buffer using buffer.advance(-1)).

Implementations

impl<T: Float> Buffer<T>

pub fn new(min_capacity: usize) -> Self

Create a new buffer with the specified minimum capacity

pub fn resize(&mut self, min_capacity: usize, value: T)

Resize the buffer to have at least the specified capacity

pub fn reset(&mut self, value: T)

Reset the buffer to a specific value

pub fn get(&self, offset: isize) -> T

Access a sample relative to the current position

pub fn set(&mut self, offset: isize, value: T)

Set a sample relative to the current position

pub fn advance(&mut self, amount: isize) -> &mut Self

Advance the buffer position by the specified amount

pub fn write<D>(&mut self, data: &[D], length: usize)

where D: Copy + Into<T>,

Write data into the buffer

pub fn read<D>(&self, length: usize, data: &mut [D])

where T: Into<D>, D: Copy,

Read data out from the buffer

pub fn view(&self) -> View<'_, T>

Create a view at the current position

pub fn view_at(&self, offset: isize) -> View<'_, T>

Create a view at a specific offset from the current position

Trait Implementations

impl<T: Float> BufferTrait<T> for Buffer<T>

fn get_ref(&self, offset: isize) -> &T

Get a reference to a sample at the specified offset