Struct VarChannelBufferRefMut 

pub struct VarChannelBufferRefMut<'a, T: Clone + Copy + Default + Sized, const MAX_CHANNELS: usize> { /* private fields */ }

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

This version uses a reference to a slice as its data source.

Implementations

impl<'a, T: Clone + Copy + Default + Sized, const MAX_CHANNELS: usize> VarChannelBufferRefMut<'a, T, MAX_CHANNELS>

pub fn empty() -> Self

Create an empty VarChannelBufferRefMut with no data.

pub fn new(data: &'a mut [T], channels: NonZeroUsize) -> Self

Create a new VarChannelBufferRefMut using the given slice as the data.

Panics

Panics if channels.get() > MAX_CHANNELS.

pub unsafe fn new_unchecked( data: &'a mut [T], frames: usize, channels: NonZeroUsize, ) -> Self

Create a new VarChannelBufferRefMut using the given slice as the data.

Safety

The caller must uphold that:

• data.len() >= frames * self.channels().get()
• and channels.get() <= MAX_CHANNELS

pub fn channels(&self) -> NonZeroUsize

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) -> ArrayVec<&[T], MAX_CHANNELS>

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

pub fn as_mut_slices(&mut self) -> ArrayVec<&mut [T], MAX_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, ) -> ArrayVec<&[T], MAX_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, ) -> ArrayVec<&mut [T], MAX_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>, ) -> ArrayVec<&[T], MAX_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>, ) -> ArrayVec<&mut [T], MAX_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 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.

Trait Implementations

impl<'a, T: Debug + Clone + Copy + Default + Sized, const MAX_CHANNELS: usize> Debug for VarChannelBufferRefMut<'a, T, MAX_CHANNELS>

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

Formats the value using the given formatter.

impl<'a, T: Clone + Copy + Default + Sized, const MAX_CHANNELS: usize> Default for VarChannelBufferRefMut<'a, T, MAX_CHANNELS>

fn default() -> Self

Returns the “default value” for a type.

impl<'a, T: Clone + Copy + Default + Sized, const MAX_CHANNELS: usize> Index<usize> for VarChannelBufferRefMut<'a, T, MAX_CHANNELS>

type Output = [T]

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<'a, T: Clone + Copy + Default + Sized, const MAX_CHANNELS: usize> IndexMut<usize> for VarChannelBufferRefMut<'a, T, MAX_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, const MAX_CHANNELS: usize> Into<&'a [T]> for VarChannelBufferRefMut<'a, T, MAX_CHANNELS>

fn into(self) -> &'a [T]

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

impl<'a, T: Clone + Copy + Default + Sized, const MAX_CHANNELS: usize> Into<&'a mut [T]> for VarChannelBufferRefMut<'a, T, MAX_CHANNELS>

fn into(self) -> &'a mut [T]

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

impl<'a, T: Clone + Copy + Default + Sized, const MAX_CHANNELS: usize> Into<VarChannelBufferRef<'a, T, MAX_CHANNELS>> for VarChannelBufferRefMut<'a, T, MAX_CHANNELS>

fn into(self) -> VarChannelBufferRef<'a, T, MAX_CHANNELS>

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

impl<'a, T: Clone + Copy + Default + Sized + Unpin, const MAX_CHANNELS: usize> Into<VarChannelBufferRefMut<'a, T, MAX_CHANNELS>> for &'a mut VarChannelBuffer<T, MAX_CHANNELS>

fn into(self) -> VarChannelBufferRefMut<'a, T, MAX_CHANNELS>

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

impl<'a, T: Clone + Copy + Default + Sized, const CHANNELS: usize> Send for VarChannelBufferRefMut<'a, T, CHANNELS>

impl<'a, T: Clone + Copy + Default + Sized, const CHANNELS: usize> Sync for VarChannelBufferRefMut<'a, T, CHANNELS>