Struct NoteBase

#[repr(C)]
pub struct NoteBase<T, Cls = C> { /* private fields */ }

The NoteBase is a generic representation of a musical note

Implementations

impl<T, Cls> NoteBase<T, Cls>

where T: RawFrequency, Cls: PitchClass,

pub fn new(pitch: Pitch<T>, octave: Octave) -> Self

pub const fn class(&self) -> &Cls

returns a copy to the index of the note’s class

pub const fn octave(&self) -> Octave

returns a copy to the octave of the note

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

returns a mutable reference to the current octave

pub fn set_class(&mut self, class: Cls) -> &mut Self

set the pitch class of the note

pub fn set_octave(&mut self, octave: Octave) -> &mut Self

set the octave of the note

pub fn with_class<Pc: PitchClass>(self) -> NoteBase<T, Pc>

consumes the current instance to create another with the given pitch class

pub fn with_octave(self, octave: Octave) -> Self

consumes the current instance to create another with the given octave

Trait Implementations

impl<T: Clone, Cls: Clone> Clone for NoteBase<T, Cls>

fn clone(&self) -> NoteBase<T, Cls>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug, Cls: Debug> Debug for NoteBase<T, Cls>

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

Formats the value using the given formatter.

impl<T, C> Default for NoteBase<T, C>

where T: Default, C: PitchClass,

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T, Cls> Deserialize<'de> for NoteBase<T, Cls>

where T: Deserialize<'de>, Cls: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<C, T> Display for NoteBase<T, C>

where C: PitchClass, T: RawFrequency,

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

Formats the value using the given formatter.

impl<T: Hash, Cls: Hash> Hash for NoteBase<T, Cls>

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<T: Ord, Cls: Ord> Ord for NoteBase<T, Cls>

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

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

fn partial_cmp(&self, other: &NoteBase<T, Cls>) -> 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<T, Cls> Serialize for NoteBase<T, Cls>

where T: Serialize, Cls: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Copy, Cls: Copy> Copy for NoteBase<T, Cls>

impl<T: Eq, Cls: Eq> Eq for NoteBase<T, Cls>

impl<T, Cls> StructuralPartialEq for NoteBase<T, Cls>