Struct persichetti::primitives::Note

pub struct Note { /* fields omitted */ }

A note is represented as a pairing of a NoteName and an Accidental. These notes have no concept of absolute pitch or octave equivalence; if you need a note with octave information, use PitchedNote.

Implementations

impl Note

pub fn new(name: NoteName, accidental: Accidental) -> Note

pub fn name(&self) -> &NoteName

pub fn accidental(&self) -> &Accidental

pub fn from_str(note: &str) -> Result<Note, NoteError>

Instantiate a Note using the shorthand documented in crate::primitives

pub fn chromatic_scale_degree(&self) -> usize

Trait Implementations

impl Add<&'_ Interval> for &Note

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

Adding an Interval I to a Note N will yeild a new note whose distance N is exactly I.

type Output = Note

The resulting type after applying the + operator.

impl Add<Interval> for Note

type Output = Note

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for Note

fn clone(&self) -> Note

Returns a copy 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 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, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Note> for Note

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Sub<&'_ Interval> for &Note

type Output = Note

The resulting type after applying the - operator.

fn sub(self, interval: &Interval) -> Self::Output

Performs the - operation.

impl Sub<Interval> for Note

type Output = Note

The resulting type after applying the - operator.

fn sub(self, rhs: Interval) -> Self::Output

Performs the - operation.

impl Eq for Note

impl StructuralEq for Note

impl StructuralPartialEq for Note