Struct Note

pub struct Note(/* private fields */);

A musical note represented as midi.

Implementations

impl Note

pub fn from_midi(val: u8, natural: bool) -> Option<Self>

Attempts to construct a new note from a raw midi value, failing if the value is out of range.

pub fn from_name(name: &str) -> Option<Self>

Attempts to construct a new note from the name of a note, accepting a range of valid formats.

pub fn get_midi(self) -> (u8, bool)

Gets the stored midi value.

pub fn get_frequency(self) -> Number

Computes the frequency of the note in Hz.

pub fn get_name(self, prefer_sharps: bool) -> CompactString

Gets the (English) name of the note.

Trait Implementations

impl Clone for Note

fn clone(&self) -> Note

Returns a duplicate 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 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 Copy for Note

impl Eq for Note

impl StructuralPartialEq for Note