Struct klib::note::Note

pub struct Note { /* private fields */ }

A note type.

This is a named pitch with an octave. This type allows for correctly attributing octave changes across an interval from one Note to another.

Implementations

impl Note

pub fn new(pitch: NamedPitch, octave: Octave) -> Self

Trait Implementations

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

fn add_assign(&mut self, rhs: Interval)

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

fn frequency(&self) -> f32

Returns the frequency of the type (usually a [Note]).

impl HasName for Note

fn name(&self) -> String

Returns the computed name of the type.

impl HasNamedPitch for Note

fn named_pitch(&self) -> NamedPitch

Returns the named pitch of the type.

impl HasOctave for Note

fn octave(&self) -> Octave

Returns the octave of the type.

impl HasPitch for Note

fn pitch(&self) -> Pitch

Returns the pitch of the type (usually a [Note]).

impl HasStaticName for Note

fn static_name(&self) -> &'static str

Returns the static name of the type.

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

fn into_chord(self) -> Chord

Converts this type into a Chord (usually a Note).

impl NoteRecreator for Note

fn with_named_pitch(self, named_pitch: NamedPitch) -> Self

Recreates this Note with the given NamedPitch.

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

Recreates this Note with the given Octave.

impl Ord for Note

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl Parsable for Note

fn parse(input: &str) -> Res<Self>where
    Self: Sized,

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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<Note> for Note

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

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

fn lt(&self, other: &Rhs) -> bool

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

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

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

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

impl Eq for Note

impl StructuralEq for Note

impl StructuralPartialEq for Note