Struct music_theory::theory::note::Note

impl Note

pub const MAX: Note = _

Biggest valid Note value.

Example:

use music_theory::theory::*;
assert_eq!(Note::MAX + Note::C3, Note::MAX);

pub const MIN: Note = _

Smallest valid Note value.

Example:

use music_theory::theory::*;
assert_eq!(Note::MIN.shift_octave(-1), Note::MIN);

pub const ZERO: Note = _

The zeroth Note, the same as Note::MIN.

Example:

use music_theory::theory::*;
assert_eq!(Note::ZERO, Note::MIN);

pub fn new(note: u32) -> Self

Create a new valid note. Will be clamped if nessesary.

Example:

use music_theory::theory::*;
assert_eq!(Note::new(12), Note::A1);

pub fn inside(&self) -> u32

Returns the inner value. You can not set the inner value directly to prevent invalid notes.

Example:

use music_theory::theory::*;
assert_eq!(Note::A2.inside(), 24);

pub fn to_pitch(&self) -> f32

Return the pitch in hertz. Note::A4 has an inner value of 48 and a pitch of 440 hz.

Example:

use music_theory::theory::*;
assert_eq!(Note::A4.to_pitch(), 440.0);

pub fn to_midi_note(&self) -> u8

Return the equivalent MIDI note. Note::A4 has an inner value of 48 and a MIDI note number of 69.

Example:

use music_theory::theory::*;
assert_eq!(Note::A4.to_midi_note(), 69);

Trait Implementations§

impl Add<Note> for Note

type Output = Note

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self::Output

Performs the + operation. Read more

impl AddAssign<Note> for Note

fn add_assign(&mut self, other: Self)

Performs the += operation. Read more

impl AddInterval for Note

fn add_interval(self, interval: Interval) -> Option<Self>

Add an Interval.

impl Clone for Note

fn clone(&self) -> Note

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl Debug for Note

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

Formats the value using the given formatter. Read more

impl Default for Note

fn default() -> Note

Returns the “default value” for a type. Read more

impl Display for Note

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

Formats the value using the given formatter. Read more

impl GeneratablePartialOrder for Note

fn next(self) -> Option<Note>

Generate the next item.

fn prev(self) -> Option<Note>

Generate the previous item.

impl Hash for Note

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more

1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more

impl Mul<Note> for Note

type Output = Note

The resulting type after applying the * operator.

fn mul(self, other: Self) -> Self::Output

Performs the * operation. Read more

impl MulAssign<Note> for Note

fn mul_assign(&mut self, other: Self)

Performs the *= operation. Read more

impl OctaveShiftable for Note

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

Have the value with everything the same except change the octave to the given one.

fn shift_octave(self, shift: OctaveShift) -> Note

Have the value with everything the same except shift the octave from the current one with the given shift.

impl Ord for Note

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

This method returns an Ordering between self and other. Read more

1.21.0 · source§

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

Compares and returns the maximum of two values. Read more

1.21.0 · source§

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

Compares and returns the minimum of two values. Read more

1.50.0 · source§

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

Restrict a value to a certain interval. Read more

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 ==.

1.0.0 · source§

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: &Note) -> Option<Ordering>

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

1.0.0 · source§

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

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

1.0.0 · source§

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

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

1.0.0 · source§

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

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

1.0.0 · source§

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

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

impl RangeBounds<Note> for Note

fn start_bound(&self) -> Bound<&Self>

Start index bound. Read more

fn end_bound(&self) -> Bound<&Self>

End index bound. Read more

1.35.0 · source§

fn contains(&self, item: &U) -> boolwhere T: PartialOrd, U: PartialOrd<T> + ?Sized,

Returns true if item is contained in the range. Read more

impl Rem<Note> for Note

type Output = Note

The resulting type after applying the % operator.

fn rem(self, other: Self) -> Self::Output

Performs the % operation. Read more

impl RemAssign<Note> for Note

fn rem_assign(&mut self, other: Self)

Performs the %= operation. Read more

impl Sub<Note> for Note

type Output = Interval

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Interval

Performs the - operation. Read more

impl ToEnharmonicNote for Note

fn to_enharmonic_note(self) -> EnharmonicNote

Take self and return EnharmonicNote.

impl ToLetterTry for Note

fn to_letter_try(&self) -> Option<Letter>

Take self and try to return Letter.

impl ToPC for Note

fn to_pc(self) -> PC

Take self and return PC.

impl Wrapper for Note

type Inner = u32

The type the new type wraps.

fn wrap(note: Self::Inner) -> Option<Self>

Try to wrap a Self::Inner type into the Self type.

fn unwrap(self) -> Self::Inner

Unwrap a Self type into a Self::Inner type.

impl Copy for Note

impl Eq for Note

impl StructuralEq for Note

impl StructuralPartialEq for Note

Auto Trait Implementations§

impl RefUnwindSafe for Note

impl Send for Note

impl Sync for Note

impl Unpin for Note

impl UnwindSafe for Note

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into for Twhere U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for Twhere T: Display + ?Sized,

default fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom for Twhere U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for Twhere U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.