Enum SampleType 

#[non_exhaustive]
pub enum SampleType {
    I16,
    I24,
    I32,
    F32,
    F64,
    Unknown,
}

Audio sample data types

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

I16

16-bit signed integer

I24

24-bit signed integer

I32

32-bit signed integer

F32

32-bit floating point

F64

64-bit floating point

Unknown

Unknown or unsupported sample type

Implementations

impl SampleType

pub const fn as_str(self) -> &'static str

Returns the canonical short name (machine-oriented)

pub const fn description(self) -> &'static str

Returns a human-readable descriptive name

pub const fn bits(self) -> Option<u32>

Returns the bit-depth of the format, if defined

pub const fn bytes(self) -> Option<usize>

Returns the size in bytes of one sample, if defined

pub const fn is_integer(self) -> bool

True if this is an integer-based sample format

pub const fn is_float(self) -> bool

True if this is a floating-point sample format

pub const fn is_dsp_native(self) -> bool

True if this format is usable for DSP operations without conversion

impl SampleType

pub fn from_type_id(type_id: TypeId) -> Option<Self>

Returns the SampleType corresponding to a TypeId, or None if unrecognized.

This is useful for SIMD dispatch code that needs to determine the concrete sample type at runtime.

Example

use audio_samples::SampleType;
use std::any::TypeId;

assert_eq!(SampleType::from_type_id(TypeId::of::<f32>()), Some(SampleType::F32));
assert_eq!(SampleType::from_type_id(TypeId::of::<String>()), None);

pub const fn from_bits(bits: u16) -> Self

Creates a sample type from a number of bits per sample.

Trait Implementations

impl Clone for SampleType

fn clone(&self) -> SampleType

Returns a duplicate 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 Display for SampleType

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

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

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl TryFrom<&str> for SampleType

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for SampleType

impl Eq for SampleType

impl StructuralPartialEq for SampleType