Enum MusicUnit 

pub enum MusicUnit {
    None,
    Beats,
    Ticks,
    Percent,
    Semitone,
    Hertz,
}

The unit a parameter value is measured in.

Carried in a MusicParamDescriptor to describe how a parameter’s value should be interpreted.

Variants

None

No unit; the value is dimensionless or categorical.

Beats

Measured in beats.

Ticks

Measured in MIDI ticks.

Percent

Measured as a percentage.

Semitone

Measured in semitones.

Hertz

Measured in hertz.

Implementations

impl MusicUnit

pub fn wire_label(self) -> &'static str

Returns the stable wire label for this unit.

Examples

use sim_lib_music_core::MusicUnit;

assert_eq!(MusicUnit::None.wire_label(), "none");
assert_eq!(MusicUnit::Hertz.wire_label(), "hertz");

pub fn symbol(self) -> Symbol

Returns the qualified music/unit symbol for this unit.

Trait Implementations

impl Clone for MusicUnit

fn clone(&self) -> MusicUnit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MusicUnit

impl Debug for MusicUnit

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

Formats the value using the given formatter.

impl Eq for MusicUnit

impl Hash for MusicUnit

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 MusicUnit

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for MusicUnit

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