Struct Note 

pub struct Note { /* private fields */ }

Struct representing musical note.

Implementations

impl Note

pub fn new( letter: Letter, octave: Octave, accidental: Accidental, ) -> Result<Self, Error>

Create new note.

pub fn letter(&self) -> Letter

Get note letter.

pub fn octave(&self) -> Octave

Get note octave.

pub fn accidental(&self) -> Accidental

Get note accidental (sharp - ♯ or flat - ♭).

pub fn enharmonic(self) -> Note

Get note with the same pitch but different accidental (or exactly the same note if there isn’t one).

For example: for C♯ - D♭ is returned.

Trait Implementations

impl Clone for Note

fn clone(&self) -> Note

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Note

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

Formats the value using the given formatter.

impl Display for Note

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

Formats the value using the given formatter.

impl From<Note> for Pitch

fn from(note: Note) -> Self

Converts to this type from the input type.

impl From<Pitch> for Note

fn from(pitch: Pitch) -> Self

Converts to this type from the input type.

impl Ord for Note

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

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

fn partial_cmp(&self, other: &Self) -> 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 Copy for Note

impl Eq for Note

impl StructuralPartialEq for Note