Struct Pitch 

pub struct Pitch {
    pub letter: NoteLetter,
    pub accidental: i8,
}

Fields

letter: NoteLetter

accidental: i8

Implementations

impl Pitch

pub fn new(letter: NoteLetter, accidental: i8) -> Self

Create a pitch with a given note letter and accidental

pub fn from_u8(val: u8) -> Self

Create a pitch from an integer, where 0 is C and everything climbs up from there, looping back around once it reaches 12.

pub fn from_u8_with_scale_context( val: u8, mode: Option<Mode>, direction: Direction, ) -> Self

Create a pitch from an integer with a preferred spelling based on mode and scale type

pub fn from_u8_with_direction(val: u8, direction: Direction) -> Self

Create a pitch from an integer with a preferred spelling based on direction

pub fn into_u8(self) -> u8

Convert the pitch into its corresponding integer, where 0 is C and 11 is B.

pub fn from_interval(pitch: Self, interval: Interval) -> Self

Create a pitch by moving up the given pitch by an interval.

pub fn from_interval_down(pitch: Self, interval: Interval) -> Self

Create a pitch by moving down the given pitch by an interval.

pub fn from_interval_with_context( pitch: Self, interval: Interval, mode: Option<Mode>, direction: Direction, ) -> Self

Create a pitch by moving up the given pitch by an interval with scale context.

pub fn from_interval_down_with_context( pitch: Self, interval: Interval, mode: Option<Mode>, direction: Direction, ) -> Self

Create a pitch by moving down the given pitch by an interval with scale context.

pub fn from_str(string: &str) -> Option<Self>

Attempt to parse a pitch from a string. It should contain the name of the note in either uppercase or lowercase, followed by #, s, S, or ♯ for sharps and b or ♭ for flats.

pub fn from_regex(string: &str) -> Result<(Self, Match<'_>), NoteError>

Parse the pitch using a regex, with the same algorithm as described in from_str.

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

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

Formats the value using the given formatter.

impl From<PitchSymbol> for Pitch

fn from(symbol: PitchSymbol) -> Self

Converts to this type from the input type.

impl FromStr for Pitch

type Err = NoteError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl PartialEq for Pitch

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

impl Eq for Pitch

impl StructuralPartialEq for Pitch