Struct ChannelBufferRef 

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

An immutable 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 a reference to a slice as its data source.

Implementations

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

pub fn empty() -> Self

Create an empty ChannelBufferRef with no data.

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

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

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

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

Safety

The caller must uphold that data.len() >= frames * CHANNELS.

pub fn frames(&self) -> usize

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

pub fn channels(&self) -> usize

The number of channels 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 as_slices(&self) -> [&[T]; CHANNELS]

Get all channels as immutable 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_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 raw(&self) -> &[T]

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

Trait Implementations

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

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.

impl<'a, T: Clone + Copy + Default + Sized, const CHANNELS: usize> Index<usize> for ChannelBufferRef<'a, T, 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 + 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, const CHANNELS: usize> Into<ChannelBufferRef<'a, T, CHANNELS>> for ChannelBufferRefMut<'a, T, CHANNELS>

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

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

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

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

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