Struct pitch_calc::hz::Hz

pub struct Hz(pub Hz);

Pitch representation in the form of a frequency (hz).

Methods

impl Hz

pub fn hz(self) -> Hz

Return the unit value of the Hz struct.

pub fn letter_octave(self) -> (Letter, Octave)

Convert to (Letter, Octave) tuple.

pub fn letter(self) -> Letter

Convert to Letter.

pub fn octave(self) -> Octave

Convert to Octave.

pub fn to_letter_octave(self) -> LetterOctave

Convert to a LetterOctave struct with the same pitch.

pub fn mel(self) -> Mel

Convert to the unit value of a Mel.

pub fn to_mel(self) -> Mel

Convert to a Mel struct.

pub fn perc(self) -> Perc

Convert to the unit value of a Perc struct.

pub fn to_perc(self) -> Perc

Convert to a percentage of the human hearing range.

pub fn scaled_perc_with_weight(self, weight: ScaleWeight) -> Perc

Convert to a scaled percentage of the human hearing range with a given weight.

pub fn scaled_perc(self) -> Perc

Convert to a scaled percentage of the human hearing range.

pub fn to_scaled_perc_with_weight(self, weight: ScaleWeight) -> ScaledPerc

Convert to a scaled percentage of the human hearing range with a given weight.

pub fn to_scaled_perc(self) -> ScaledPerc

Convert to a scaled percentage of the human hearing range.

pub fn step(self) -> Step

Convert to the unit value of a Step.

pub fn to_step(self) -> Step

Convert to a floating point MIDI-esque Step.

Trait Implementations

impl Add<Hz> for Hz

type Output = Hz

The resulting type after applying the + operator.

fn add(self, rhs: Hz) -> Hz

Performs the + operation.

impl Clone for Hz

fn clone(&self) -> Hz

Returns a copy 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

Formats the value using the given formatter.

impl Div<Hz> for Hz

type Output = Hz

The resulting type after applying the / operator.

fn div(self, rhs: Hz) -> Hz

Performs the / operation.

impl Eq for Hz

impl From<Hz> for Mel

fn from(other: Hz) -> Self

Performs the conversion.

impl From<Hz> for LetterOctave

fn from(other: Hz) -> Self

Performs the conversion.

impl From<Hz> for ScaledPerc

fn from(other: Hz) -> Self

Performs the conversion.

impl From<Hz> for Perc

fn from(other: Hz) -> Self

Performs the conversion.

impl From<Hz> for Step

fn from(other: Hz) -> Self

Performs the conversion.

impl From<LetterOctave> for Hz

fn from(other: LetterOctave) -> Self

Performs the conversion.

impl From<Mel> for Hz

fn from(other: Mel) -> Self

Performs the conversion.

impl From<Perc> for Hz

fn from(other: Perc) -> Self

Performs the conversion.

impl From<ScaledPerc> for Hz

fn from(other: ScaledPerc) -> Self

Performs the conversion.

impl From<Step> for Hz

fn from(other: Step) -> Self

Performs the conversion.

impl From<f32> for Hz

fn from(other: CalcHz) -> Self

Performs the conversion.

impl Mul<Hz> for Hz

type Output = Hz

The resulting type after applying the * operator.

fn mul(self, rhs: Hz) -> Hz

Performs the * operation.

impl Neg for Hz

type Output = Hz

The resulting type after applying the - operator.

fn neg(self) -> Hz

Performs the unary - operation.

impl Ord for Hz

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<Hz> for Hz

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Hz> for Hz

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

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

#[must_use]fn lt(&self, other: &Rhs) -> bool

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

#[must_use]fn le(&self, other: &Rhs) -> bool

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

#[must_use]fn gt(&self, other: &Rhs) -> bool

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

#[must_use]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 Rem<Hz> for Hz

type Output = Hz

The resulting type after applying the % operator.

fn rem(self, rhs: Hz) -> Hz

Performs the % operation.

impl Sub<Hz> for Hz

type Output = Hz

The resulting type after applying the - operator.

fn sub(self, rhs: Hz) -> Hz

Performs the - operation.