Struct Pitch 

pub struct Pitch { /* private fields */ }

A musical pitch with spelling, octave, accidental and optional microtone.

Implementations

impl Pitch

pub fn from_options(options: PitchOptions) -> Result<Self>

Builds a pitch from PitchOptions.

pub fn builder() -> PitchOptions

Creates a PitchOptions builder.

pub fn from_name(name: impl Into<String>) -> Result<Self>

Builds a pitch from a name such as "C#4" or "E-".

pub fn from_number(number: FloatType) -> Result<Self>

Builds a pitch from a pitch-space number.

pub fn from_step(step: char) -> Result<Self>

Builds a pitch from a diatonic step.

pub fn from_name_and_octave( name: impl Into<String>, octave: IntegerType, ) -> Result<Self>

Builds a pitch from a pitch name and explicit octave.

pub fn from_pitch_class( pitch_class: impl Into<PitchClassSpecifier>, ) -> Result<Self>

Builds a pitch from a pitch class.

pub fn from_midi(midi: IntegerType) -> Result<Self>

Builds a pitch from a MIDI note number.

pub fn from_pitch_space(ps: FloatType) -> Result<Self>

Builds a pitch from a pitch-space value.

pub fn name_with_octave(&self) -> String

Returns the pitch name with the octave suffix when one is set.

pub fn name(&self) -> String

Returns the pitch name without octave, such as "F#" or "B-".

pub fn alter(&self) -> FloatType

Returns the total semitone alteration from the natural step.

pub fn accidental(&self) -> &Accidental

Returns this pitch’s accidental object.

Unlike Python music21, this crate stores an explicit natural accidental for natural pitches.

pub fn microtone(&self) -> Option<&Microtone>

Returns this pitch’s microtone adjustment, when present.

pub fn pitch_class(&self) -> PitchClass

Returns this pitch’s normalized pitch class.

pub fn ps(&self) -> FloatType

Returns the pitch-space value for this pitch.

pub fn pitch_space(&self) -> FloatType

Returns the pitch-space value for this pitch.

pub fn midi(&self) -> IntegerType

Returns the nearest MIDI note number for this pitch.

pub fn frequency_hz(&self) -> FloatType

Returns this pitch’s twelve-tone equal-temperament frequency in hertz.

pub fn frequency_hz_in(&self, tuning_system: TuningSystem) -> FloatType

Returns this pitch’s frequency in hertz for a supported tuning system.

The pitch-space value is used as the tuning-system degree index, so this is most musically meaningful for twelve-tone systems.

pub fn simplify_enharmonic(&self, most_common: bool) -> Result<Pitch>

Returns a simpler enharmonic spelling of this pitch.

When most_common is true, common spellings such as E- are preferred over less common equivalents such as D#, following music21’s Pitch.simplifyEnharmonic behavior.

pub fn simplify_enharmonic_in_place(&mut self, most_common: bool) -> Result<()>

Simplifies this pitch’s enharmonic spelling in place.

pub fn get_higher_enharmonic(&self) -> Result<Pitch>

Returns the next higher enharmonic spelling.

pub fn get_higher_enharmonic_in_place(&mut self) -> Result<()>

Replaces this pitch with its next higher enharmonic spelling.

pub fn get_lower_enharmonic(&self) -> Result<Pitch>

Returns the next lower enharmonic spelling.

pub fn get_lower_enharmonic_in_place(&mut self) -> Result<()>

Replaces this pitch with its next lower enharmonic spelling.

pub fn octave(&self) -> Octave

Returns the stored octave.

Returns None when the pitch was created without an explicit octave, such as Pitch::from_name("C"). In calculations, octave-less pitches use the library default octave.

Trait Implementations

impl Clone for Pitch

fn clone(&self) -> Pitch

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Pitch

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

Formats the value using the given formatter.

impl Default for Pitch

fn default() -> Self

Returns the “default value” for a type.

impl Display for Pitch

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

Formats the value using the given formatter.

impl FromStr for Pitch

type Err = Error

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Self>

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

impl IntoNote for &Pitch

fn try_into_note(self) -> Result<Note>

Converts the value into a note.

const FROM_INTEGER_PITCH: bool = false

Whether this value came from an integer pitch class or MIDI-like number.

impl IntoNote for Pitch

fn try_into_note(self) -> Result<Note>

Converts the value into a note.

const FROM_INTEGER_PITCH: bool = false

Whether this value came from an integer pitch class or MIDI-like number.

impl PartialEq for Pitch

fn eq(&self, other: &Self) -> 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 TryFrom<&Pitch> for Note

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &Pitch) -> Result<Self>

Performs the conversion.

impl TryFrom<&Pitch> for Pitch

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &Pitch) -> Result<Self>

Performs the conversion.

impl TryFrom<&str> for Pitch

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self>

Performs the conversion.

impl TryFrom<Pitch> for Note

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Pitch) -> Result<Self>

Performs the conversion.

impl TryFrom<String> for Pitch

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self>

Performs the conversion.

impl TryFrom<f64> for Pitch

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: FloatType) -> Result<Self>

Performs the conversion.

impl TryFrom<i32> for Pitch

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: IntegerType) -> Result<Self>

Performs the conversion.