Struct pitch_calc::step::Step

pub struct Step(pub Step);

Pitch representation in the form of a MIDI-esque Step.

Methods

impl Step

fn step(&self) -> Step

Return the value in steps.

fn hz(&self) -> Hz

Return the unit value of the equivalent frequency Hz.

fn to_hz(&self) -> Hz

Convert to the equivalent frequency in Hz.

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

Convert to the closest equivalent (Letter, Octave).

fn letter(&self) -> Letter

Convert to the closest equivalent Letter.

fn octave(&self) -> Octave

Convert to the closest equivalent Octave.

fn to_letter_octave(&self) -> LetterOctave

Convert to the closest equivalent LetterOctave.

fn mel(&self) -> Mel

Convert to a Mel unit value.

fn to_mel(&self) -> Mel

Convert to a Mel struct.

fn perc(&self) -> Perc

Convert to the unit value of the equivalent Perc.

fn to_perc(&self) -> Perc

Convert to a percentage of the human hearing range.

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

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

fn scaled_perc(&self) -> Perc

Convert to a scaled percentage of the human hearing range.

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

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

fn to_scaled_perc(&self) -> ScaledPerc

Convert to a scaled percentage of the human hearing range.

Trait Implementations

impl Decodable for Step

fn decode<__D: Decoder>(__arg_0: &mut __D) -> Result<Step, __D::Error>

impl Encodable for Step

fn encode<__S: Encoder>(&self, __arg_0: &mut __S) -> Result<(), __S::Error>

impl Clone for Step

fn clone(&self) -> Step

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Step

impl Debug for Step

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Add for Step

type Output = Step

The resulting type after applying the + operator

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

The method for the + operator

impl Sub for Step

type Output = Step

The resulting type after applying the - operator

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

The method for the - operator

impl Mul for Step

type Output = Step

The resulting type after applying the * operator

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

The method for the * operator

impl Div for Step

type Output = Step

The resulting type after applying the / operator

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

The method for the / operator

impl Rem for Step

type Output = Step

The resulting type after applying the % operator

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

The method for the % operator

impl Neg for Step

type Output = Step

The resulting type after applying the - operator

fn neg(self) -> Step

The method for the unary - operator

impl PartialEq for Step

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

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

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

This method tests for !=.

impl Eq for Step

impl PartialOrd for Step

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

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

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

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

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

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

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

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

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 Ord for Step

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

This method returns an Ordering between self and other.