Struct audio_processor_traits::audio_buffer::VecAudioBuffer

pub struct VecAudioBuffer<SampleType> { /* private fields */ }

An owned version of the interleaved buffer implementation. Can be converted onto an InterleavedAudioBuffer.

Implementations

impl<SampleType: Clone> VecAudioBuffer<SampleType>

pub fn new_with(
    buffer: Vec<SampleType>,
    num_channels: usize,
    num_samples: usize
) -> Self

pub fn empty_with(
    num_channels: usize,
    num_samples: usize,
    value: SampleType
) -> Self

impl<SampleType: Clone> VecAudioBuffer<SampleType>

pub fn new_with_size(
    num_channels: usize,
    num_samples: usize,
    sample: SampleType
) -> Self

pub fn interleaved(&mut self) -> InterleavedAudioBuffer<'_, SampleType>

Get an InterleavedAudioBuffer reference type out this VecAudioBuffer.

Trait Implementations

impl<SampleType> AudioBuffer for VecAudioBuffer<SampleType>

type SampleType = SampleType

The type of samples within this buffer.

fn num_channels(&self) -> usize

The number of channels in this buffer

fn num_samples(&self) -> usize

The number of samples in this buffer

fn slice(&self) -> &[Self::SampleType]

Get a slice to the internal data. Will not work with VST adapter

fn slice_mut(&mut self) -> &mut [Self::SampleType]

Get a mutable slice to the internal data. Will not work with VST adapter

fn get(&self, channel: usize, sample: usize) -> &Self::SampleType

Get a ref to an INPUT sample in this buffer.

fn get_mut(&mut self, channel: usize, sample: usize) -> &mut Self::SampleType

Get a mutable ref to an OUTPUT sample in this buffer

fn set(&mut self, channel: usize, sample: usize, value: Self::SampleType)

Set an OUTPUT sample in this buffer

unsafe fn get_unchecked(&self, channel: usize, sample: usize) -> &Self::SampleType

Unsafe, no bounds check - Get a ref to an INPUT sample in this buffer

unsafe fn get_unchecked_mut(
    &mut self,
    channel: usize,
    sample: usize
) -> &mut Self::SampleType

Unsafe, no bounds check - Get a mutable ref to an OUTPUT sample in this buffer

unsafe fn set_unchecked(
    &mut self,
    channel: usize,
    sample: usize,
    value: Self::SampleType
)

Unsafe, no bounds check - Set an OUTPUT sample in this buffer

fn frames(&self) -> Chunks<'_, Self::SampleType>

Shortcut for .slice().chunks(num_channels)

fn frames_mut(&mut self) -> ChunksMut<'_, Self::SampleType>

Shortcut for .slice_mut().chunks_mut(num_channels)

impl<SampleType: Clone> Clone for VecAudioBuffer<SampleType>

fn clone(&self) -> VecAudioBuffer<SampleType>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<SampleType: Debug> Debug for VecAudioBuffer<SampleType>

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

Formats the value using the given formatter.

impl<SampleType: Clone> From<Vec<SampleType, Global>> for VecAudioBuffer<SampleType>

fn from(simple_vec: Vec<SampleType>) -> Self

Converts to this type from the input type.

impl<SampleType: Clone> OwnedAudioBuffer for VecAudioBuffer<SampleType>

fn new() -> Self

Create an empty buffer of this type

fn resize(
    &mut self,
    num_channels: usize,
    num_samples: usize,
    sample: Self::SampleType
)

Resize the buffer to fit num_channels and num_samples

impl<SampleType: PartialEq> PartialEq<VecAudioBuffer<SampleType>> for VecAudioBuffer<SampleType>

fn eq(&self, other: &VecAudioBuffer<SampleType>) -> bool

This method tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<SampleType: Eq> Eq for VecAudioBuffer<SampleType>

impl<SampleType> StructuralEq for VecAudioBuffer<SampleType>

impl<SampleType> StructuralPartialEq for VecAudioBuffer<SampleType>