Struct audio_time::SampleType

pub struct SampleType { /* private fields */ }

A type used to encode a single sample, created from a type that implements audio_core::Sample.

This struct “erases” the type it was created with, to allow it to be used as a const generic. On creation, it encodes the size of the sample type, which can be retrieved later using byte_depth.

The struct also encodes the type’s unique type_id, so that two SampleTypes created from different types with the same size are not equal, e.g.:

assert_eq!(SampleType::new::<i16>(), SampleType::new::<i16>());
assert_ne!(SampleType::new::<i16>(), SampleType::new::<u16>());

Implementations

impl SampleType

pub const fn new<Sample: Sample + 'static>() -> Self

pub const fn byte_depth(&self) -> NonZeroU8

The number of bytes used to represent this sample type.

Trait Implementations

impl Clone for SampleType

fn clone(&self) -> SampleType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SampleType

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

Formats the value using the given formatter.

impl Hash for SampleType

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SampleType

fn cmp(&self, other: &SampleType) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<SampleType> for SampleType

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

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

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 PartialOrd<SampleType> for SampleType

fn partial_cmp(&self, other: &SampleType) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for SampleType

impl Eq for SampleType

impl StructuralEq for SampleType

impl StructuralPartialEq for SampleType