Struct Data 

pub struct Data { /* private fields */ }

A buffer of dynamically typed audio data, passed to raw stream callbacks.

Raw input stream callbacks receive &Data, while raw output stream callbacks expect &mut Data.

Implementations

impl Data

pub unsafe fn from_parts( data: *mut (), len: usize, sample_format: SampleFormat, ) -> Self

Constructor for host implementations to use.

Safety

The following requirements must be met in order for the safety of Data’s API.

• The data pointer must point to the first sample in the slice containing all samples.
• The len must describe the length of the buffer as a number of samples in the expected format specified via the sample_format argument.
• The sample_format must correctly represent the underlying sample data delivered/expected by the stream.

pub fn sample_format(&self) -> SampleFormat

The sample format of the internal audio data.

pub fn len(&self) -> usize

The full length of the buffer in samples.

The returned length is the same length as the slice of type T that would be returned via as_slice given a sample type that matches the inner sample format.

pub fn bytes(&self) -> &[u8]

The raw slice of memory representing the underlying audio data as a slice of bytes.

It is up to the user to interpret the slice of memory based on Data::sample_format.

pub fn bytes_mut(&mut self) -> &mut [u8]

The raw slice of memory representing the underlying audio data as a slice of bytes.

It is up to the user to interpret the slice of memory based on Data::sample_format.

pub fn as_slice<T>(&self) -> Option<&[T]>

where T: SizedSample,

Access the data as a slice of sample type T.

Returns None if the sample type does not match the expected sample format.

pub fn as_slice_mut<T>(&mut self) -> Option<&mut [T]>

where T: SizedSample,

Access the data as a slice of sample type T.

Returns None if the sample type does not match the expected sample format.

Trait Implementations

impl Debug for Data

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

Formats the value using the given formatter.