Struct ChannelBuffer 

pub struct ChannelBuffer<T: Clone + Copy + Default + Sized + Unpin, const CHANNELS: usize> { /* private fields */ }

A memory-efficient buffer of samples with a fixed compile-time number of channels each with a fixed runtime number of frames (samples in a single channel of audio).

This version uses an owned Vec as its data source.

Implementations

impl<T: Clone + Copy + Default + Sized + Unpin, const CHANNELS: usize> ChannelBuffer<T, CHANNELS>

pub fn empty() -> Self

Create an empty ChannelBuffer with no allocated capacity.

pub fn new(frames: usize) -> Self

Create a new ChannelBuffer allocated with the given number of channels each allocated with the given number of frames (samples in a single channel of audio).

All data will be initialized with the default value.

pub unsafe fn new_uninit(frames: usize) -> Self

Create a new ChannelBuffer allocated with the given number of channels each allocated with the given number of frames (samples in a single channel of audio).

No data will be initialized.

Safety

Any data must be initialized before reading.

pub fn channels(&self) -> usize

The number of channels in this buffer.

pub fn frames(&self) -> usize

The number of frames (samples in a single channel of audio) that are allocated in this buffer.

pub fn channel(&self, index: usize) -> Option<&[T]>

Get an immutable reference to the channel at index. The slice will have a length of self.frames().

Returns None if index is out of bounds.

pub unsafe fn channel_unchecked(&self, index: usize) -> &[T]

Get an immutable reference to the channel at index. The slice will have a length of self.frames().

Safety

index must be less than self.channels()

pub fn channel_mut(&mut self, index: usize) -> Option<&mut [T]>

Get a mutable reference to the channel at index. The slice will have a length of self.frames().

Returns None if index is out of bounds.

pub unsafe fn channel_unchecked_mut(&mut self, index: usize) -> &mut [T]

Get a mutable reference to the channel at index. The slice will have a length of self.frames().

Safety

index must be less than self.channels()

pub fn as_slices(&self) -> [&[T]; CHANNELS]

Get all channels as immutable slices. Each slice will have a length of self.frames().

pub fn as_mut_slices(&mut self) -> [&mut [T]; CHANNELS]

Get all channels as mutable slices. Each slice will have a length of self.frames().

pub fn as_slices_with_length(&self, frames: usize) -> [&[T]; CHANNELS]

Get all channels as immutable slices with the given length in frames.

If frames > self.frames(), then each slice will have a length of self.frames() instead.

pub fn as_mut_slices_with_length( &mut self, frames: usize, ) -> [&mut [T]; CHANNELS]

Get all channels as mutable slices with the given length in frames.

If frames > self.frames(), then each slice will have a length of self.frames() instead.

pub fn as_slices_with_range(&self, range: Range<usize>) -> [&[T]; CHANNELS]

Get all channels as immutable slices in the given range.

If all or part of the range falls out of bounds, then only the part that falls within range will be returned.

pub fn as_mut_slices_with_range( &mut self, range: Range<usize>, ) -> [&mut [T]; CHANNELS]

Get all channels as mutable slices in the given range.

If all or part of the range falls out of bounds, then only the part that falls within range will be returned.

pub fn raw(&self) -> &[T]

Get the entire contents of the buffer as a single immutable slice.

pub fn raw_mut(&mut self) -> &mut [T]

Get the entire contents of the buffer as a single mutable slice.

pub fn clear(&mut self)

Clear all data with the default value.

pub fn clear_frames(&mut self, frames: usize)

Clear all data in each channel up to frames with the default value.

pub fn as_ref<'a>(&'a self) -> ChannelBufferRef<'a, T, CHANNELS>

pub fn as_mut<'a>(&'a mut self) -> ChannelBufferRefMut<'a, T, CHANNELS>

Trait Implementations

impl<T: Clone + Copy + Default + Sized + Unpin, const CHANNELS: usize> Clone for ChannelBuffer<T, CHANNELS>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Clone + Copy + Default + Sized + Unpin, const CHANNELS: usize> Debug for ChannelBuffer<T, CHANNELS>

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

Formats the value using the given formatter.

impl<T: Clone + Copy + Default + Sized + Unpin, const CHANNELS: usize> Default for ChannelBuffer<T, CHANNELS>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Clone + Copy + Default + Sized + Unpin, const CHANNELS: usize> Index<usize> for ChannelBuffer<T, CHANNELS>

type Output = [T]

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T: Clone + Copy + Default + Sized + Unpin, const CHANNELS: usize> IndexMut<usize> for ChannelBuffer<T, CHANNELS>

fn index_mut(&mut self, index: usize) -> &mut Self::Output

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

impl<'a, T: Clone + Copy + Default + Sized + Unpin, const CHANNELS: usize> Into<ChannelBufferRef<'a, T, CHANNELS>> for &'a ChannelBuffer<T, CHANNELS>

fn into(self) -> ChannelBufferRef<'a, T, CHANNELS>

Converts this type into the (usually inferred) input type.

impl<'a, T: Clone + Copy + Default + Sized + Unpin, const CHANNELS: usize> Into<ChannelBufferRefMut<'a, T, CHANNELS>> for &'a mut ChannelBuffer<T, CHANNELS>

fn into(self) -> ChannelBufferRefMut<'a, T, CHANNELS>

Converts this type into the (usually inferred) input type.

impl<T: Clone + Copy + Default + Sized + Unpin, const CHANNELS: usize> Into<Vec<T>> for ChannelBuffer<T, CHANNELS>

fn into(self) -> Vec<T>

Converts this type into the (usually inferred) input type.

impl<T: Clone + Copy + Default + Sized + Unpin, const CHANNELS: usize> Send for ChannelBuffer<T, CHANNELS>

impl<T: Clone + Copy + Default + Sized + Unpin, const CHANNELS: usize> Sync for ChannelBuffer<T, CHANNELS>