Struct Hz 

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

A frequency in hertz: a finite value of zero or more.

use sound_to_patch::units::Hz;

let a4 = Hz::new(440.0)?;
assert!(Hz::new(-1.0).is_err());

Implementations

impl Hz

pub fn new(value: f64) -> Result<Hz, RangeError>

Checks the value against the range of the type.

Errors

Returns a RangeError for NaN, an infinity or a value outside the range.

pub fn get(self) -> f64

Returns the inner value.

Trait Implementations

impl Clone for Hz

fn clone(&self) -> Hz

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Hz

impl Debug for Hz

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Hz

fn deserialize<__D>( __deserializer: __D, ) -> Result<Hz, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Hz

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

Prints the shortest number that parses back to the same value, then the first suffix.

impl From<MidiPitch> for Hz

fn from(pitch: MidiPitch) -> Hz

Converts with equal temperament, A4 = 440 Hz: f = 440 * 2^((m - 69) / 12). Every MIDI pitch gives a valid frequency, from about 8.18 Hz to about 12544 Hz.

impl FromStr for Hz

type Err = ParseUnitError

The associated error which can be returned from parsing.

fn from_str(input: &str) -> Result<Hz, ParseUnitError>

Parses a string s to return a value of this type.

impl PartialEq for Hz

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Hz

fn partial_cmp(&self, other: &Hz) -> 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 Serialize for Hz

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Spread for Hz

impl StructuralPartialEq for Hz

impl TryFrom<Hz> for MidiPitch

fn try_from(frequency: Hz) -> Result<MidiPitch, RangeError>

Converts with equal temperament, A4 = 440 Hz: m = 69 + 12 * log2(f / 440).

Errors

Returns a RangeError for 0 Hz, which has no pitch, and for a frequency outside MIDI notes 0 to 127.

type Error = RangeError

The type returned in the event of a conversion error.

impl TryFrom<f64> for Hz

type Error = RangeError

The type returned in the event of a conversion error.

fn try_from(value: f64) -> Result<Hz, RangeError>

Performs the conversion.