Struct SampleRate 

pub struct SampleRate(pub NonZeroU32);

A sample rate in hertz, guaranteed non-zero.

Use one of the HZ_* constants for the rates audiofp supports out of the box, or SampleRate::new to validate an arbitrary value.

Example

use audiofp::SampleRate;

assert_eq!(SampleRate::HZ_44100.hz(), 44_100);
assert!(SampleRate::new(0).is_none());

Tuple Fields

0: NonZeroU32

Implementations

impl SampleRate

pub const HZ_8000: SampleRate

8 kHz — the rate audiofp’s classical fingerprinters consume.

pub const HZ_11025: SampleRate

11.025 kHz.

pub const HZ_16000: SampleRate

16 kHz — typical speech rate.

pub const HZ_22050: SampleRate

22.05 kHz — common for music workflows.

pub const HZ_44100: SampleRate

44.1 kHz — CD-quality audio.

pub const HZ_48000: SampleRate

48 kHz — DAT / professional audio.

pub const fn new(hz: u32) -> Option<SampleRate>

Build a SampleRate from any non-zero u32.

Returns None if hz == 0.

Example

use audiofp::SampleRate;

assert_eq!(SampleRate::new(32_000).unwrap().hz(), 32_000);
assert!(SampleRate::new(0).is_none());

pub const fn hz(self) -> u32

Return the rate in hertz.

Example

use audiofp::SampleRate;

assert_eq!(SampleRate::HZ_48000.hz(), 48_000);

Trait Implementations

impl Clone for SampleRate

fn clone(&self) -> SampleRate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SampleRate

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

Formats the value using the given formatter.

impl Hash for SampleRate

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 SampleRate

fn eq(&self, other: &SampleRate) -> 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 Copy for SampleRate

impl Eq for SampleRate

impl StructuralPartialEq for SampleRate