Struct DelayLine 

pub struct DelayLine<T, const MAX_DELAY: usize>
where
    T: Transcendental,
{ /* private fields */ }

Delay line for audio effects — single-threaded circular buffer.

Provides a circular buffer for implementing delay, reverb, and other time-based effects.

Thread safety

DelayLine is not thread-safe. It is designed for single-threaded use inside the audio graph. Use PipeBuffer or RingBuffer for cross-thread communication.

Implementations

impl<T, const MAX_DELAY: usize> DelayLine<T, MAX_DELAY>

where T: Transcendental,

pub fn new(sample_rate: f32) -> DelayLine<T, MAX_DELAY>

Create a new delay line with the given sample rate.

Panics

Panics if MAX_DELAY is 0.

pub fn set_delay(&mut self, delay_sec: f32)

Set the delay time in seconds.

pub fn set_delay_samples(&mut self, samples: usize)

Set the delay time in samples.

pub fn delay_samples(&self) -> usize

Current delay in samples.

pub const fn max_delay(&self) -> usize

Maximum possible delay (const generic parameter).

pub fn sample_rate(&self) -> f32

The sample rate used for sec-to-sample conversion.

pub fn write(&mut self, input: T) -> T

Write a sample and return the delayed sample.

pub fn read(&self) -> T

Read the delayed sample without writing.

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

Read sample at arbitrary delay (0 = most recent).

pub fn read_interpolated(&self, delay_frac: f32) -> T

Read with linear interpolation between samples.

pub fn clear(&mut self)

Clear the delay line (fill with zeros).

pub fn write_position(&self) -> usize

Current write cursor position in the circular buffer.

Trait Implementations

impl<T, const MAX_DELAY: usize> Buffer<T> for DelayLine<T, MAX_DELAY>

where T: Transcendental,

fn capacity(&self) -> usize

Maximum number of elements the buffer can hold.

fn len(&self) -> usize

Current number of elements in the buffer.

fn is_empty(&self) -> bool

Whether the buffer is empty (len() == 0).

fn is_full(&self) -> bool

Whether the buffer is full (len() == capacity()).

fn as_slice(&self) -> &[T]

Read-only access to the buffer data.

fn as_mut_slice(&mut self) -> &mut [T]

Mutable access to the buffer data.

fn fill(&mut self, value: T)

Fill the entire buffer with a value.

fn copy_from(&mut self, src: &[T])

Copy data from a slice. Copies min(src.len(), self.len()) samples.

fn clear(&mut self)

Remove all items from the buffer.

fn stats(&self) -> BufferStats

Snapshot of performance statistics.

fn reset_stats(&mut self)

Reset performance counters (not the data).

impl<T, const MAX_DELAY: usize> Index<usize> for DelayLine<T, MAX_DELAY>

where T: Transcendental,

type Output = T

The returned type after indexing.

fn index( &self, index: usize, ) -> &<DelayLine<T, MAX_DELAY> as Index<usize>>::Output

Performs the indexing (container[index]) operation.

impl<T, const MAX_DELAY: usize> IndexMut<usize> for DelayLine<T, MAX_DELAY>

where T: Transcendental,

fn index_mut( &mut self, index: usize, ) -> &mut <DelayLine<T, MAX_DELAY> as Index<usize>>::Output

Performs the mutable indexing (container[index]) operation.