Struct Aspn

#[repr(C)]
pub struct Aspn { /* private fields */ }

An american scientific pitch notation (Aspn) representation of a musical note; this standard is used to represent notes in a way that is consistent with the American scientific pitch notation system, which uses a combination of a pitch class (represented as an integer) and an octave (represented as an Octave) to uniquely identify a musical note. The pitch class is the note’s position in the chromatic scale, while the octave indicates the note’s position in the musical range.

Implementations

impl Aspn

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 const fn octave_mut(&mut self) -> &mut Octave

returns a mutable reference to the current octave

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

set the pitch class of the note

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

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 Aspn

type Output = Aspn

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for Aspn

type Output = Aspn

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<usize> for Aspn

fn add_assign(&mut self, rhs: usize)

Performs the += operation.

impl AddAssign for Aspn

fn add_assign(&mut self, rhs: Aspn)

Performs the += operation.

impl Clone for Aspn

fn clone(&self) -> Aspn

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Aspn

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

Formats the value using the given formatter.

impl Default for Aspn

fn default() -> Aspn

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Aspn

where Aspn: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Aspn

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

Formats the value using the given formatter.

impl From<(i128, Octave)> for Aspn

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

Converts to this type from the input type.

impl From<(i16, Octave)> for Aspn

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

Converts to this type from the input type.

impl From<(i32, Octave)> for Aspn

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

Converts to this type from the input type.

impl From<(i64, Octave)> for Aspn

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

Converts to this type from the input type.

impl From<(i8, Octave)> for Aspn

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

Converts to this type from the input type.

impl From<(isize, Octave)> for Aspn

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

Converts to this type from the input type.

impl From<(u128, Octave)> for Aspn

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

Converts to this type from the input type.

impl From<(u16, Octave)> for Aspn

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

Converts to this type from the input type.

impl From<(u32, Octave)> for Aspn

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

Converts to this type from the input type.

impl From<(u64, Octave)> for Aspn

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

Converts to this type from the input type.

impl From<(u8, Octave)> for Aspn

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

Converts to this type from the input type.

impl From<(usize, Octave)> for Aspn

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

Converts to this type from the input type.

impl From<i128> for Aspn

fn from(class: i128) -> Self

Converts to this type from the input type.

impl From<i16> for Aspn

fn from(class: i16) -> Self

Converts to this type from the input type.

impl From<i32> for Aspn

fn from(class: i32) -> Self

Converts to this type from the input type.

impl From<i64> for Aspn

fn from(class: i64) -> Self

Converts to this type from the input type.

impl From<i8> for Aspn

fn from(class: i8) -> Self

Converts to this type from the input type.

impl From<isize> for Aspn

fn from(class: isize) -> Self

Converts to this type from the input type.

impl From<u128> for Aspn

fn from(class: u128) -> Self

Converts to this type from the input type.

impl From<u16> for Aspn

fn from(class: u16) -> Self

Converts to this type from the input type.

impl From<u32> for Aspn

fn from(class: u32) -> Self

Converts to this type from the input type.

impl From<u64> for Aspn

fn from(class: u64) -> Self

Converts to this type from the input type.

impl From<u8> for Aspn

fn from(class: u8) -> Self

Converts to this type from the input type.

impl From<usize> for Aspn

fn from(class: usize) -> Self

Converts to this type from the input type.

impl Hash for Aspn

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 Aspn

fn cmp(&self, other: &Aspn) -> 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<Aspn> for usize

fn eq(&self, other: &Aspn) -> 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 PartialEq<usize> for Aspn

fn eq(&self, other: &usize) -> 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 PartialEq for Aspn

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

fn partial_cmp(&self, other: &Aspn) -> 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 PartialOrd<usize> for Aspn

fn partial_cmp(&self, other: &usize) -> 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 PartialOrd for Aspn

fn partial_cmp(&self, other: &Aspn) -> 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 Serialize for Aspn

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub<usize> for Aspn

type Output = Aspn

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<usize> for Aspn

fn sub_assign(&mut self, rhs: usize)

Performs the -= operation.

impl Copy for Aspn

impl Eq for Aspn

impl StructuralPartialEq for Aspn