Struct SampleRate 

pub struct SampleRate(/* private fields */);

A sample rate in samples per second: a whole number above zero.

Implementations

impl SampleRate

pub fn new(rate: u32) -> Result<SampleRate, AudioError>

Checks that the rate is above zero.

Errors

Returns an AudioError for zero.

pub fn get(self) -> u32

Returns the rate in samples per second.

pub fn hz(self) -> Hz

Returns the rate as a frequency.

pub fn nyquist(self) -> Hz

Returns the Nyquist frequency, half the rate.

pub fn seconds(self, samples: usize) -> Seconds

Returns the time of a sample index.

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 Copy for SampleRate

impl Debug for SampleRate

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

Formats the value using the given formatter.

impl Display for SampleRate

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

Formats the value using the given formatter.

impl Eq for SampleRate

impl Hash for SampleRate

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

where __H: Hasher,

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 SampleRate

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for SampleRate

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for SampleRate

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralPartialEq for SampleRate