Note

eryon_nrt::types::note

Struct Note

pub struct Note { /* private fields */ }

Implementations§

impl Note

pub fn new(class: usize, Octave: Octave) -> Self

pub fn from_pitch(pitch: usize) -> Self

returns a new note from a pitch value

pub const fn class(&self) -> usize

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

pub fn class_mut(&mut self) -> &mut usize

returns a mutable reference to the index of the note’s class

pub const fn octave(&self) -> Octave

returns a copy to the octave of the note

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

returns a mutable reference to the current octave

pub fn set_class(&mut self, class: usize)

set the pitch class of the note

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

set the octave of the note

pub fn with_class(self, class: usize) -> Self

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 Add<usize> for Note

type Output = Note

The resulting type after applying the + operator.

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

Performs the + operation. Read more

impl Add for Note

type Output = Note

The resulting type after applying the + operator.

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

Performs the + operation. Read more

impl AddAssign<usize> for Note

fn add_assign(&mut self, rhs: usize)

Performs the += operation. Read more

impl AddAssign for Note

fn add_assign(&mut self, rhs: Note)

Performs the += operation. Read more

impl Clone for Note

fn clone(&self) -> Note

Returns a duplicate 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 From<(i128, Octave)> for Note

fn from((class, octave): (i128, Octave)) -> Self

Converts to this type from the input type.

impl From<(i16, Octave)> for Note

fn from((class, octave): (i16, Octave)) -> Self

Converts to this type from the input type.

impl From<(i32, Octave)> for Note

fn from((class, octave): (i32, Octave)) -> Self

Converts to this type from the input type.

impl From<(i64, Octave)> for Note

fn from((class, octave): (i64, Octave)) -> Self

Converts to this type from the input type.

impl From<(i8, Octave)> for Note

fn from((class, octave): (i8, Octave)) -> Self

Converts to this type from the input type.

impl From<(isize, Octave)> for Note

fn from((class, octave): (isize, Octave)) -> Self

Converts to this type from the input type.

impl From<(u128, Octave)> for Note

fn from((class, octave): (u128, Octave)) -> Self

Converts to this type from the input type.

impl From<(u16, Octave)> for Note

fn from((class, octave): (u16, Octave)) -> Self

Converts to this type from the input type.

impl From<(u32, Octave)> for Note

fn from((class, octave): (u32, Octave)) -> Self

Converts to this type from the input type.

impl From<(u64, Octave)> for Note

fn from((class, octave): (u64, Octave)) -> Self

Converts to this type from the input type.

impl From<(u8, Octave)> for Note

fn from((class, octave): (u8, Octave)) -> Self

Converts to this type from the input type.

impl From<(usize, Octave)> for Note

fn from((class, octave): (usize, Octave)) -> Self

Converts to this type from the input type.

impl From<i128> for Note

fn from(class: i128) -> Self

Converts to this type from the input type.

impl From<i16> for Note

fn from(class: i16) -> Self

Converts to this type from the input type.

impl From<i32> for Note

fn from(class: i32) -> Self

Converts to this type from the input type.

impl From<i64> for Note

fn from(class: i64) -> Self

Converts to this type from the input type.

impl From<i8> for Note

fn from(class: i8) -> Self

Converts to this type from the input type.

impl From<isize> for Note

fn from(class: isize) -> Self

Converts to this type from the input type.

impl From<u128> for Note

fn from(class: u128) -> Self

Converts to this type from the input type.

impl From<u16> for Note

fn from(class: u16) -> Self

Converts to this type from the input type.

impl From<u32> for Note

fn from(class: u32) -> Self

Converts to this type from the input type.

impl From<u64> for Note

fn from(class: u64) -> Self

Converts to this type from the input type.

impl From<u8> for Note

fn from(class: u8) -> Self

Converts to this type from the input type.

impl From<usize> for Note

fn from(class: usize) -> 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. 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 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) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more

1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more

1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more

impl PartialEq for Note

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

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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. Read more

1.0.0 · Source§

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

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

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

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

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

impl Sub<usize> for Note

type Output = Note

The resulting type after applying the - operator.

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

Performs the - operation. Read more

impl SubAssign<usize> for Note

fn sub_assign(&mut self, rhs: usize)

Performs the -= operation. Read more

impl Copy for Note

impl Eq for Note

impl StructuralPartialEq for Note

Auto Trait Implementations§

impl Freeze for Note

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 T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where 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> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<Idx, T> IntoIndex<Idx> for T
where T: Into<Index<Idx>>,

fn into_index(self) -> Index<Idx>

impl<T> IntoNote for T
where T: Into<Note>,

fn into_note(self) -> Note

impl<T> ToOwned for T
where 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 T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T
where 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<U>>::Error>

Performs the conversion.

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

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.