Struct ukebox::note::Note

pub struct Note {
    pub pitch_class: PitchClass,
    // some fields omitted
}

A note such a C, C# and so on.

Fields

pitch_class: PitchClass

Implementations

impl Note

pub fn new(pitch_class: PitchClass, staff_position: StaffPosition) -> Self

pub fn is_white_note(&self) -> bool

Return true if this note is a “white note”, i.e. a note represented by a white key on the piano (i.e. the note is part of the C major scale).

Trait Implementations

impl Add<Interval> for Note

type Output = Self

The resulting type after applying the + operator.

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

Get the next note when adding interval to the current note.

impl Add<u8> for Note

type Output = Self

The resulting type after applying the + operator.

fn add(self, n: Semitones) -> Self

Performs the + operation.

impl Clone for Note

fn clone(&self) -> Note

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Note

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

impl From<PitchClass> for Note

fn from(pitch_class: PitchClass) -> Self

Convert a pitch class into a note. For notes that can be sharp or flat use the sharp version.

impl FromStr for Note

type Err = ParseNoteError

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

fn cmp(&self, other: &Note) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Note> for Note

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

Treat two notes as equal if they have the same pitch class. For example, B sharp, C and D double flat should all match.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Note> for Note

fn partial_cmp(&self, other: &Note) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for Note

impl Sub<u8> for Note

type Output = Self

The resulting type after applying the - operator.

fn sub(self, n: Semitones) -> Self

Performs the - operation.