Struct InstanceChannelBuffer 

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

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

Implementations

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

pub fn empty() -> Self

Create an empty [InstanceBuffer] with no allocated capacity.

pub fn new(num_instances: usize, frames: usize) -> Self

Create a new InstanceChannelBuffer allocated with the given number of instances, each 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(num_instances: usize, frames: usize) -> Self

Create a new InstanceChannelBuffer allocated with the given number of instances, each 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 num_instances(&self) -> usize

The number of instances in this buffer.

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 instance<'a>( &'a self, index: usize, ) -> Option<ChannelBufferRef<'a, T, CHANNELS>>

Get an immutable reference to the instance at the given index.

Returns None if index is out of bounds.

pub unsafe fn instance_unchecked<'a>( &'a self, index: usize, ) -> ChannelBufferRef<'a, T, CHANNELS>

Get an immutable reference to the instance at the given index.

Safety

index must be less than self.num_instances().

pub fn instance_mut<'a>( &'a mut self, index: usize, ) -> Option<ChannelBufferRefMut<'a, T, CHANNELS>>

Get a mutable reference to the instance at the given index.

Returns None if index is out of bounds.

pub unsafe fn instance_unchecked_mut<'a>( &'a mut self, index: usize, ) -> ChannelBufferRefMut<'a, T, CHANNELS>

Get a mutable reference to the instance at the given index.

Safety

index must be less than self.num_instances().

pub fn all_instances<'a>( &'a self, ) -> [ChannelBufferRef<'a, T, CHANNELS>; INSTANCES]

Get an immutable reference to all instances.

pub fn all_instances_mut<'a>( &'a mut self, ) -> [ChannelBufferRefMut<'a, T, CHANNELS>; INSTANCES]

Get a mutable reference to all instances.

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.

Trait Implementations

impl<T: Clone + Copy + Default + Sized + Unpin, const INSTANCES: usize, const CHANNELS: usize> Clone for InstanceChannelBuffer<T, INSTANCES, 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 INSTANCES: usize, const CHANNELS: usize> Debug for InstanceChannelBuffer<T, INSTANCES, CHANNELS>

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.

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

fn into(self) -> Vec<T>

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

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

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