Struct redact_composer_musical::Note

pub struct Note(pub u8);

A musical note, corresponding to a specific frequency in 12 tone equal temperament space.

Tuple Fields

0: u8

Implementations

impl Note

pub fn pitch_class(&self) -> PitchClass

Returns the note’s PitchClass.

use redact_composer_musical::{Note, NoteName::C, PitchClass};

assert_eq!(Note::from((C, 4)).pitch_class(), PitchClass(0));

pub fn octave(&self) -> i8

Returns the octave number of this note:

use redact_composer_musical::{Note, NoteName::{B, C}};

assert_eq!(Note::from((C, 0)).octave(), 0);
assert_eq!(Note::from((B, 5)).octave(), 5);

pub fn interval_with(&self, other_note: &Note) -> Interval

Returns the interval between this note and another.

use redact_composer_musical::{Interval, Note, NoteName::C};

assert_eq!(Note::from((C, 3)).interval_with(&Note::from((C, 4))), Interval::Octave);

Trait Implementations

impl Add<Interval> for Note

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

Adds an interval to this note, resulting in another note.

use redact_composer_musical::{Interval as I, Note, NoteName::{C, G}};

let c3 = Note::from((C, 4));
assert_eq!(c3, Note(60));
assert_eq!(c3 + I::P5, Note::from((G, 4)));

type Output = Note

The resulting type after applying the + operator.

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 From<(NoteName, i8)> for Note

fn from(value: (NoteName, i8)) -> Self

use redact_composer_musical::{Note, NoteName::C};

assert_eq!(Note::from((C, 4)), Note(60));

impl From<(PitchClass, i8)> for Note

fn from(value: (PitchClass, i8)) -> Self

use redact_composer_musical::{Note, NoteName::C, PitchClass};

let c3 = Note::from((PitchClass(0), 4));
assert_eq!(c3, Note(60));

impl From<Note> for PitchClass

fn from(value: Note) -> Self

Converts to this type from the input 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 Ord for Note

fn cmp(&self, other: &Note) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq<(NoteName, i8)> for Note

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

use redact_composer_musical::{Note, NoteName::*};
assert_eq!(Note(60), (C, 4));

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 PartialEq<Note> for (NoteName, i8)

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

use redact_composer_musical::{Note, NoteName::*};
assert_eq!((C, 4), Note(60));

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 PartialEq<PitchClass> for Note

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

use redact_composer_musical::{Note, NoteName::C, PitchClass};

assert!(Note::from((C, 3)) == PitchClass::from(C));

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

fn partial_cmp(&self, other: &Note) -> 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 Sub<Interval> for Note

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

Subtracts an interval from this note, resulting in another note.

use redact_composer_musical::{Interval as I, Note, NoteName::{C, G}};

let c3 = Note::from((C, 3));
assert_eq!(c3 - I::P4, Note::from((G, 2)));

type Output = Note

The resulting type after applying the - operator.

impl SubAssign<Interval> for Note

fn sub_assign(&mut self, rhs: Interval)

Performs the -= operation.

impl Copy for Note

impl Eq for Note

impl StructuralPartialEq for Note