Struct SampleWindow 

pub struct SampleWindow { /* private fields */ }

The newest capacity audio samples, oldest first.

Stored samples are already sanitized: non-finite values are 0.0 and finite values lie in [-1, 1]. Capacity 0 is allowed and holds nothing.

Implementations

impl SampleWindow

pub fn new(capacity: usize) -> Self

Create an empty window holding at most capacity samples.

Capacity 0 is allowed: such a window ignores every push and stays empty. The only allocation this type ever makes is here (and in Self::samples / Self::copy_into for the caller’s copy).

pub fn push(&mut self, frame: &[f32])

Append a frame, keeping the newest samples and dropping the oldest.

A frame longer than the capacity keeps its tail. Non-finite samples are stored as 0.0 and finite ones are clamped to [-1, 1]. Never allocates.

pub const fn len(&self) -> usize

Number of samples currently held.

pub const fn is_empty(&self) -> bool

Whether the window holds no samples.

pub fn capacity(&self) -> usize

Maximum number of samples the window holds.

pub fn clear(&mut self)

Drop every sample; the capacity (and the storage) is unchanged.

pub fn samples(&self) -> Vec<f32>

The window, oldest sample first. Allocates; see Self::copy_into.

pub fn copy_into(&self, out: &mut Vec<f32>)

Clear out and fill it with the window, oldest sample first.

Reuses out’s allocation when it is large enough.

pub fn peak(&self) -> f32

Largest magnitude in the window; 0.0 when empty.

pub fn rms(&self) -> f32

Root mean square of the window; 0.0 when empty.

Trait Implementations

impl Clone for SampleWindow

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SampleWindow

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

Formats the value using the given formatter.

impl PartialEq for SampleWindow

Two windows are equal when they have the same capacity and hold the same samples in the same order; the rotation of the ring storage is irrelevant. Stored samples are never NaN, so this is a true equivalence.

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.