Struct AudioBuffer

pub struct AudioBuffer<S>
where
    S: Sample,
{ /* private fields */ }

A buffer for storing audio sample data.

Used internally by the DSP graph for block input/output buffers. Wraps a Vec<S> with convenience methods for audio processing.

Implementations

impl<S> AudioBuffer<S>

where S: Sample,

pub fn new(capacity: usize) -> AudioBuffer<S>

Create an AudioBuffer of a particular capacity, automatically filled with zeroes.

pub fn with_data(data: Vec<S>) -> AudioBuffer<S>

Create an AudioBuffer initialized with a given set of values.

pub fn capacity(&self) -> usize

Get the capacity of the AudioBuffer.

pub fn fill(&mut self, value: S)

Fill the AudioBuffer with a particular value.

pub fn copy_from_slice(&mut self, source: &[S])

Copy the values from a given source to the AudioBuffer.

pub fn copy_to_slice(&self, target: &mut [S])

Copy the AudioBuffer’s values to a given slice.

pub fn as_ptr(&self) -> *const S

Get the AudioBuffer as a pointer to its contents.

pub fn as_mut_ptr(&mut self) -> *mut S

Get the AudioBuffer as a mutable pointer to its contents.

pub fn extend_from_slice(&mut self, slice: &[S])

Append the AudioBuffer with data from a given slice.

pub fn drain_front(&mut self, count: usize) -> Drain<'_, S>

Drain the first count values from the AudioBuffer.

Trait Implementations

impl<S> Buffer<S> for AudioBuffer<S>

where S: Sample,

fn len(&self) -> usize

Get the length of the Buffer.

fn is_empty(&self) -> bool

Check if the Buffer is empty.

fn as_slice(&self) -> &[S]

Get the Buffer as a data slice.

fn as_mut_slice(&mut self) -> &mut [S]

Get the Buffer as a mutable data slice.

fn clear(&mut self)

Remove all values from the Buffer

fn zeroize(&mut self)

Set all values in the Buffer to zero.

impl<S> Clone for AudioBuffer<S>

where S: Clone + Sample,

fn clone(&self) -> AudioBuffer<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S> Debug for AudioBuffer<S>

where S: Debug + Sample,

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

Formats the value using the given formatter.

impl<S> Extend<S> for AudioBuffer<S>

where S: Sample,

fn extend<I>(&mut self, iter: I)

where I: IntoIterator<Item = S>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<S> Index<usize> for AudioBuffer<S>

where S: Sample,

type Output = S

The returned type after indexing.

fn index(&self, index: usize) -> &<AudioBuffer<S> as Index<usize>>::Output

Performs the indexing (container[index]) operation.

impl<S> IndexMut<usize> for AudioBuffer<S>

where S: Sample,

fn index_mut( &mut self, index: usize, ) -> &mut <AudioBuffer<S> as Index<usize>>::Output

Performs the mutable indexing (container[index]) operation.