Struct Note

pub struct Note {
    pub alphabet: Alphabet,
    pub accidental: Accidental,
    pub octave: u8,
}

Fields

alphabet: Alphabet

accidental: Accidental

octave: u8

Implementations

impl Note

pub const fn new(alphabet: Alphabet, accidental: Accidental, octave: u8) -> Self

pub const fn simplify(&self) -> Self

The enharmonic equivalent of a note will be returned in a simpler form on the note.

Compatability

This method might not return the same exact value from release to release, however, it is guaranteed to be an enharmonic equivalent to the supplied note.

pub const fn id(&self) -> Pitch

Returns the number of half-steps from A4.

pub const fn from_id(id: Pitch) -> Self

pub const fn increment(&self) -> Self

Increments the note by one half-step.

pub const fn decrement(&self) -> Self

Decrements the note by one half-step.

pub const fn increment_by(&self, steps: i64) -> Self

pub const fn decrement_by(&self, steps: i64) -> Self

Trait Implementations

impl Add<Interval> for Note

type Output = Note

The resulting type after applying the + operator.

fn add(self, interval: Interval) -> Note

Performs the + operation.

impl Add<Note> for Accidental

type Output = Note

The resulting type after applying the + operator.

fn add(self, rhs: Note) -> Self::Output

Performs the + operation.

impl Add<Note> for Chord

type Output = Chord

The resulting type after applying the + operator.

fn add(self, note: Note) -> Chord

Performs the + operation.

impl Add for Note

type Output = Chord

The resulting type after applying the + operator.

fn add(self, other: Self) -> Chord

Performs the + operation.

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 Hash for Note

fn hash<__H: Hasher>(&self, state: &mut __H)

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 PartialEq for Note

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 Sub<Interval> for Note

type Output = Note

The resulting type after applying the - operator.

fn sub(self, interval: Interval) -> Note

Performs the - operation.

impl Sub for Note

type Output = Interval

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Interval

Performs the - operation.

impl Copy for Note

impl Eq for Note