Struct Pitch 

pub struct Pitch {
    pub class: PitchClass,
    pub octave: i16,
}

An octave-aware pitch: a PitchClass together with an octave number.

The octave follows the MIDI convention in which middle C (C4) is MIDI note 60, so Pitch::semitone returns a continuous semitone index across octaves.

Fields

class: PitchClass

The mod-12 pitch class.

octave: i16

The octave number, with C4 (MIDI 60) in octave 4.

Implementations

impl Pitch

pub fn semitone(self) -> i32

Returns the absolute semitone index of this pitch, where MIDI 60 (C4) is 60.

pub fn from_semitone(semitone: i32) -> Pitch

Constructs a pitch from an absolute semitone index, the inverse of Pitch::semitone.

pub fn to_midi(self) -> Option<u8>

Returns the MIDI note number for this pitch, or None if it falls outside the playable range 0..=127.

pub fn from_midi(value: u8) -> Pitch

Constructs a pitch from a MIDI note number.

pub fn transpose(self, semitones: i32) -> Pitch

Returns this pitch shifted by semitones, preserving the MIDI mapping.

pub fn invert(self, axis: Pitch) -> Pitch

Returns the inversion of this pitch about axis.

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

impl Debug for Pitch

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

Formats the value using the given formatter.

impl Eq for Pitch

impl FromStr for Pitch

type Err = PitchError

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Pitch, <Pitch as FromStr>::Err>

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

impl Hash for Pitch

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 Pitch

fn cmp(&self, other: &Pitch) -> 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.

impl PartialEq for Pitch

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Pitch

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