Struct NoteBase 

pub struct NoteBase<P = CNote, K = <P as RawPitchClass>::Tag>
where
    P: RawPitchClass<Tag = K>,
    K: RawAccidental,
{ /* private fields */ }

The NoteBase is a generic representation of a musical note

Implementations

impl<P, K> NoteBase<P, K>

where P: RawPitchClass<Tag = K>, K: RawAccidental,

pub const fn new(class: PitchClass<P, K>, octave: Octave) -> Self

constructs a new NoteBase instance

pub fn from_octave(octave: Octave) -> Self

where P: PitchClassRepr, K: Accidental,

initialize a new instance of the note from the given octave

pub const fn class(&self) -> &PitchClass<P, K>

returns a reference to the current class

pub const fn class_mut(&mut self) -> &mut PitchClass<P, K>

returns a mutable reference to the current class

pub const fn octave(&self) -> &Octave

returns a reference to the current octave

pub const fn octave_mut(&mut self) -> &mut Octave

returns a mutable reference to the current octave

pub fn aspn(&self) -> String

returns string formatted following the American Standard Pitch Notation (ASPN) of: “C.4”, “D#.5”, etc.

impl<P> NoteBase<P>

where P: RawPitchClass,

pub fn natural(class: P, octave: Octave) -> NoteBase<P, Natural>

where P: RawPitchClass<Tag = Natural>,

returns a new natural note of the given class and octave

pub fn sharp(class: P, octave: Octave) -> NoteBase<P, Sharp>

where P: RawPitchClass<Tag = Sharp>,

returns a new sharp note of the given class and octave

pub fn flat(class: P, octave: Octave) -> NoteBase<P, Flat>

where P: RawPitchClass<Tag = Flat>,

returns a new flat note of the given class and octave

Trait Implementations

impl<P, K> Clone for NoteBase<P, K>

where P: RawPitchClass<Tag = K> + Clone, K: RawAccidental + Clone,

fn clone(&self) -> NoteBase<P, K>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P, K> Debug for NoteBase<P, K>

where P: RawPitchClass<Tag = K>, K: RawAccidental,

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

Formats the value using the given formatter.

impl<P, K> Default for NoteBase<P, K>

where P: RawPitchClass<Tag = K> + Default, K: RawAccidental + Default,

fn default() -> NoteBase<P, K>

Returns the “default value” for a type.

impl<P, K> Display for NoteBase<P, K>

where P: RawPitchClass<Tag = K>, K: RawAccidental,

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

Formats the value using the given formatter.

impl<P, K> FromStr for NoteBase<P, K>

where P: PitchClassRepr<Tag = K>, K: Accidental, <P as FromStr>::Err: Debug,

Available on crate feature alloc only.

type Err = Error

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<P, K> Hash for NoteBase<P, K>

where P: RawPitchClass<Tag = K> + Hash, K: RawAccidental + Hash,

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<P, K> Ord for NoteBase<P, K>

where P: RawPitchClass<Tag = K> + Ord, K: RawAccidental + Ord,

fn cmp(&self, other: &NoteBase<P, K>) -> 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<P, K> PartialEq<&str> for NoteBase<P, K>

where P: RawPitchClass<Tag = K>, K: RawAccidental,

fn eq(&self, other: &&str) -> 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<P, K> PartialEq<str> for NoteBase<P, K>

where P: RawPitchClass<Tag = K>, K: RawAccidental,

fn eq(&self, other: &str) -> 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<P, K> PartialEq for NoteBase<P, K>

where P: RawPitchClass<Tag = K> + PartialEq, K: RawAccidental + PartialEq,

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

where P: RawPitchClass<Tag = K> + PartialOrd, K: RawAccidental + PartialOrd,

fn partial_cmp(&self, other: &NoteBase<P, K>) -> 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<P, K> Copy for NoteBase<P, K>

where P: RawPitchClass<Tag = K> + Copy, K: RawAccidental + Copy,

impl<P, K> Eq for NoteBase<P, K>

where P: RawPitchClass<Tag = K> + Eq, K: RawAccidental + Eq,

impl<P, K> StructuralPartialEq for NoteBase<P, K>

where P: RawPitchClass<Tag = K>, K: RawAccidental,