Struct cpal::Data

source ·
pub struct Data { /* private fields */ }
Expand description

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§

source§

impl Data

source

pub fn sample_format(&self) -> SampleFormat

The sample format of the internal audio data.

source

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.

source

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.

source

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.

source

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.

source

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§

source§

impl Debug for Data

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl RefUnwindSafe for Data

§

impl !Send for Data

§

impl !Sync for Data

§

impl Unpin for Data

§

impl UnwindSafe for Data

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<S> FromSample<S> for S

source§

fn from_sample_(s: S) -> S

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> ToSample<U> for T
where U: FromSample<T>,

source§

fn to_sample_(self) -> U

source§

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

§

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>,

§

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.
source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,