Struct Note

pub struct Note { /* private fields */ }

Implementations

impl Note

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

pub fn from_pitch(pitch: impl IntoPitch) -> Self

Returns a new instance of the note with the given pitch; the note’s octave is set to the default octave (4).

pub fn class(&self) -> Pitches

Returns an instance of the note’s PitchClass. Each pitch class is a synmoblic representation of a group of frequencies, which are separated by a factor of 2^(1/12).

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

Returns an owned instance of the note’s octave

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

Returns a mutable reference to the note’s octave

pub const fn pitch(&self) -> &Pitch

Returns an owned instance of the note’s pitch

pub fn pitch_mut(&mut self) -> &mut Pitch

Returns a mutable reference to the note’s pitch

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

Sets the note’s octave

pub fn set_pitch(&mut self, Pitch: Pitch)

Sets the note’s pitch

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

Returns a new instance of the note with the given octave

pub fn with_pitch(self, Pitch: Pitch) -> Note

Returns a new instance of the note with the given pitch

Trait Implementations

impl<'a> Add<&'a Note> for &'a Intervals

type Output = Note

The resulting type after applying the + operator.

fn add(self, rhs: &'a Note) -> Self::Output

Performs the + operation.

impl<'a> Add<&'a Note> for Intervals

type Output = Note

The resulting type after applying the + operator.

fn add(self, rhs: &'a Note) -> Self::Output

Performs the + operation.

impl<'a> Add<&'a Note> for Note

type Output = Note

The resulting type after applying the + operator.

fn add(self, rhs: &'a Note) -> Self::Output

Performs the + operation.

impl<'a> Add<Intervals> for &'a Note

type Output = Note

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Intervals> for Note

type Output = Note

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'a> Add<Note> for &'a Intervals

type Output = Note

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'a> Add<Note> for &'a Note

type Output = Note

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Note> for Intervals

type Output = Note

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'a> Add for &'a Note

type Output = Note

The resulting type after applying the + operator.

fn add(self, rhs: &'a Note) -> Self::Output

Performs the + operation.

impl Add for Note

type Output = Note

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<Intervals> for Note

fn add_assign(&mut self, rhs: Intervals)

Performs the += operation.

impl AddAssign for Note

fn add_assign(&mut self, rhs: Note)

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

fn default() -> Note

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Note

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Note

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

Formats the value using the given formatter.

impl<'a> Div<&'a Note> for &'a Intervals

type Output = Note

The resulting type after applying the / operator.

fn div(self, rhs: &'a Note) -> Self::Output

Performs the / operation.

impl<'a> Div<&'a Note> for Intervals

type Output = Note

The resulting type after applying the / operator.

fn div(self, rhs: &'a Note) -> Self::Output

Performs the / operation.

impl<'a> Div<&'a Note> for Note

type Output = Note

The resulting type after applying the / operator.

fn div(self, rhs: &'a Note) -> Self::Output

Performs the / operation.

impl<'a> Div<Intervals> for &'a Note

type Output = Note

The resulting type after applying the / operator.

fn div(self, rhs: Intervals) -> Self::Output

Performs the / operation.

impl Div<Intervals> for Note

type Output = Note

The resulting type after applying the / operator.

fn div(self, rhs: Intervals) -> Self::Output

Performs the / operation.

impl<'a> Div<Note> for &'a Intervals

type Output = Note

The resulting type after applying the / operator.

fn div(self, rhs: Note) -> Self::Output

Performs the / operation.

impl<'a> Div<Note> for &'a Note

type Output = Note

The resulting type after applying the / operator.

fn div(self, rhs: Note) -> Self::Output

Performs the / operation.

impl Div<Note> for Intervals

type Output = Note

The resulting type after applying the / operator.

fn div(self, rhs: Note) -> Self::Output

Performs the / operation.

impl<'a> Div for &'a Note

type Output = Note

The resulting type after applying the / operator.

fn div(self, rhs: &'a Note) -> Self::Output

Performs the / operation.

impl Div for Note

type Output = Note

The resulting type after applying the / operator.

fn div(self, rhs: Note) -> Self::Output

Performs the / operation.

impl DivAssign<Intervals> for Note

fn div_assign(&mut self, rhs: Intervals)

Performs the /= operation.

impl DivAssign for Note

fn div_assign(&mut self, rhs: Note)

Performs the /= operation.

impl From<(Octave, Pitch)> for Note

fn from((octave, pitch): (Octave, Pitch)) -> Self

Converts to this type from the input type.

impl From<Note> for (Octave, Pitch)

fn from(note: Note) -> Self

Converts to this type from the input type.

impl From<Note> for Pitch

fn from(note: Note) -> Self

Converts to this type from the input type.

impl From<Pitch> for Note

fn from(pitch: Pitch) -> 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 IntervalOps for Note

type Output = Note

fn add_interval<I: IntoInterval>(&self, interval: I) -> Self::Output

Add an interval to the given object

fn sub_interval<I: IntoInterval>(&self, interval: I) -> Self::Output

Subtract an interval from the given object

fn add_semitone(&self) -> Self::Output

fn sub_semitone(&self) -> Self::Output

fn add_tone(&self) -> Self::Output

fn sub_tone(&self) -> Self::Output

fn add_major_third(&self) -> Self::Output

fn sub_major_third(&self) -> Self::Output

fn add_minor_third(&self) -> Self::Output

fn sub_minor_third(&self) -> Self::Output

fn add_perfect_fifth(&self) -> Self::Output

fn sub_perfect_fifth(&self) -> Self::Output

fn add_augmented_fifth(&self) -> Self::Output

fn sub_augmented_fifth(&self) -> Self::Output

fn add_diminished_fifth(&self) -> Self::Output

fn sub_diminished_fifth(&self) -> Self::Output

fn add_augmented_seventh(&self) -> Self::Output

fn sub_augmented_seventh(&self) -> Self::Output

fn add_diminished_seventh(&self) -> Self::Output

fn sub_diminished_seventh(&self) -> Self::Output

fn add_major_seventh(&self) -> Self::Output

fn sub_major_seventh(&self) -> Self::Output

fn add_minor_seventh(&self) -> Self::Output

fn sub_minor_seventh(&self) -> Self::Output

fn add_octave(&self) -> Self::Output

fn sub_octave(&self) -> Self::Output

impl<'a> Mul<&'a Note> for &'a Intervals

type Output = Note

The resulting type after applying the * operator.

fn mul(self, rhs: &'a Note) -> Self::Output

Performs the * operation.

impl<'a> Mul<&'a Note> for Intervals

type Output = Note

The resulting type after applying the * operator.

fn mul(self, rhs: &'a Note) -> Self::Output

Performs the * operation.

impl<'a> Mul<&'a Note> for Note

type Output = Note

The resulting type after applying the * operator.

fn mul(self, rhs: &'a Note) -> Self::Output

Performs the * operation.

impl<'a> Mul<Intervals> for &'a Note

type Output = Note

The resulting type after applying the * operator.

fn mul(self, rhs: Intervals) -> Self::Output

Performs the * operation.

impl Mul<Intervals> for Note

type Output = Note

The resulting type after applying the * operator.

fn mul(self, rhs: Intervals) -> Self::Output

Performs the * operation.

impl<'a> Mul<Note> for &'a Intervals

type Output = Note

The resulting type after applying the * operator.

fn mul(self, rhs: Note) -> Self::Output

Performs the * operation.

impl<'a> Mul<Note> for &'a Note

type Output = Note

The resulting type after applying the * operator.

fn mul(self, rhs: Note) -> Self::Output

Performs the * operation.

impl Mul<Note> for Intervals

type Output = Note

The resulting type after applying the * operator.

fn mul(self, rhs: Note) -> Self::Output

Performs the * operation.

impl<'a> Mul for &'a Note

type Output = Note

The resulting type after applying the * operator.

fn mul(self, rhs: &'a Note) -> Self::Output

Performs the * operation.

impl Mul for Note

type Output = Note

The resulting type after applying the * operator.

fn mul(self, rhs: Note) -> Self::Output

Performs the * operation.

impl MulAssign<Intervals> for Note

fn mul_assign(&mut self, rhs: Intervals)

Performs the *= operation.

impl MulAssign for Note

fn mul_assign(&mut self, rhs: Note)

Performs the *= operation.

impl Notable for Note

fn pitch(&self) -> Pitch

Find the modular index of the given pitch

fn pitch_class(&self) -> Pitches

Classify the pitch into a pitch class

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,

Restrict a value to a certain interval.

impl PartialEq for Note

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

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<'a> Rem<&'a Note> for &'a Intervals

type Output = Note

The resulting type after applying the % operator.

fn rem(self, rhs: &'a Note) -> Self::Output

Performs the % operation.

impl<'a> Rem<&'a Note> for Intervals

type Output = Note

The resulting type after applying the % operator.

fn rem(self, rhs: &'a Note) -> Self::Output

Performs the % operation.

impl<'a> Rem<&'a Note> for Note

type Output = Note

The resulting type after applying the % operator.

fn rem(self, rhs: &'a Note) -> Self::Output

Performs the % operation.

impl<'a> Rem<Intervals> for &'a Note

type Output = Note

The resulting type after applying the % operator.

fn rem(self, rhs: Intervals) -> Self::Output

Performs the % operation.

impl Rem<Intervals> for Note

type Output = Note

The resulting type after applying the % operator.

fn rem(self, rhs: Intervals) -> Self::Output

Performs the % operation.

impl<'a> Rem<Note> for &'a Intervals

type Output = Note

The resulting type after applying the % operator.

fn rem(self, rhs: Note) -> Self::Output

Performs the % operation.

impl<'a> Rem<Note> for &'a Note

type Output = Note

The resulting type after applying the % operator.

fn rem(self, rhs: Note) -> Self::Output

Performs the % operation.

impl Rem<Note> for Intervals

type Output = Note

The resulting type after applying the % operator.

fn rem(self, rhs: Note) -> Self::Output

Performs the % operation.

impl<'a> Rem for &'a Note

type Output = Note

The resulting type after applying the % operator.

fn rem(self, rhs: &'a Note) -> Self::Output

Performs the % operation.

impl Rem for Note

type Output = Note

The resulting type after applying the % operator.

fn rem(self, rhs: Note) -> Self::Output

Performs the % operation.

impl RemAssign<Intervals> for Note

fn rem_assign(&mut self, rhs: Intervals)

Performs the %= operation.

impl RemAssign for Note

fn rem_assign(&mut self, rhs: Note)

Performs the %= operation.

impl Serialize for Note

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> Sub<&'a Note> for &'a Intervals

type Output = Note

The resulting type after applying the - operator.

fn sub(self, rhs: &'a Note) -> Self::Output

Performs the - operation.

impl<'a> Sub<&'a Note> for Intervals

type Output = Note

The resulting type after applying the - operator.

fn sub(self, rhs: &'a Note) -> Self::Output

Performs the - operation.

impl<'a> Sub<&'a Note> for Note

type Output = Note

The resulting type after applying the - operator.

fn sub(self, rhs: &'a Note) -> Self::Output

Performs the - operation.

impl<'a> Sub<Intervals> for &'a Note

type Output = Note

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<Intervals> for Note

type Output = Note

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'a> Sub<Note> for &'a Intervals

type Output = Note

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'a> Sub<Note> for &'a Note

type Output = Note

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<Note> for Intervals

type Output = Note

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'a> Sub for &'a Note

type Output = Note

The resulting type after applying the - operator.

fn sub(self, rhs: &'a Note) -> Self::Output

Performs the - operation.

impl Sub for Note

type Output = Note

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<Intervals> for Note

fn sub_assign(&mut self, rhs: Intervals)

Performs the -= operation.

impl SubAssign for Note

fn sub_assign(&mut self, rhs: Note)

Performs the -= operation.

impl Copy for Note

impl Eq for Note

impl Send for Note

impl StructuralPartialEq for Note

impl Sync for Note