Skip to main content

ChannelBuffer

Struct ChannelBuffer 

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

A memory-efficient buffer of samples with CHANNELS channels. Each channel has a length of frames.

Implementations§

Source§

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

Source

pub const fn empty() -> Self

Source

pub fn new(frames: usize) -> Self

Source

pub fn frames(&self) -> usize

Source

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

Get an immutable reference to the first channel.

Source

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

Get a mutable reference to the first channel.

Source

pub fn first_with_frames(&self, frames: usize) -> &[T]

Get an immutable reference to the first channel with the given number of frames.

The length of the returned slice will be either frames or the number of frames in this buffer, whichever is smaller.

Source

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

Get a mutable reference to the first channel with the given number of frames.

The length of the returned slice will be either frames or the number of frames in this buffer, whichever is smaller.

Source

pub fn channels<const NUM_CHANNELS: usize>(&self) -> [&[T]; NUM_CHANNELS]

Get an immutable reference to the first given number of channels in this buffer.

Source

pub fn channels_mut<const NUM_CHANNELS: usize>( &mut self, ) -> [&mut [T]; NUM_CHANNELS]

Get a mutable reference to the first given number of channels in this buffer.

Source

pub fn channels_with_frames<const NUM_CHANNELS: usize>( &self, frames: usize, ) -> [&[T]; NUM_CHANNELS]

Get an immutable reference to the first given number of channels with the given number of frames.

The length of the returned slices will be either frames or the number of frames in this buffer, whichever is smaller.

Source

pub fn channels_with_frames_mut<const NUM_CHANNELS: usize>( &mut self, frames: usize, ) -> [&mut [T]; NUM_CHANNELS]

Get a mutable reference to the first given number of channels with the given number of frames.

The length of the returned slices will be either frames or the number of frames in this buffer, whichever is smaller.

Source

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

Get an immutable reference to all channels in this buffer.

Source

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

Get a mutable reference to all channels in this buffer.

Source

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

Get an immutable reference to all channels with the given number of frames.

The length of the returned slices will be either frames or the number of frames in this buffer, whichever is smaller.

Source

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

Get a mutable reference to all channels with the given number of frames.

The length of the returned slices will be either frames or the number of frames in this buffer, whichever is smaller.

Auto Trait Implementations§

§

impl<T, const CHANNELS: usize> Freeze for ChannelBuffer<T, CHANNELS>

§

impl<T, const CHANNELS: usize> RefUnwindSafe for ChannelBuffer<T, CHANNELS>
where T: RefUnwindSafe,

§

impl<T, const CHANNELS: usize> Send for ChannelBuffer<T, CHANNELS>
where T: Send,

§

impl<T, const CHANNELS: usize> Sync for ChannelBuffer<T, CHANNELS>
where T: Sync,

§

impl<T, const CHANNELS: usize> Unpin for ChannelBuffer<T, CHANNELS>
where T: Unpin,

§

impl<T, const CHANNELS: usize> UnwindSafe for ChannelBuffer<T, CHANNELS>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.