Scale

Struct Scale 

Source
pub struct Scale {
    pub name: String,
    pub intervals: Option<Vec<u8>>,
    pub intervals_ascending: Option<Vec<u8>>,
    pub intervals_descending: Option<Vec<u8>>,
    pub notes: Option<Vec<u8>>,
    pub notes_ascending: Option<Vec<u8>>,
    pub notes_descending: Option<Vec<u8>>,
    pub origin: Option<String>,
}
Expand description

Represents a musical scale with various properties.

Fields§

§name: String

The name of the scale (e.g., “Major”, “Dorian”).

§intervals: Option<Vec<u8>>

The intervals of the scale in semitones, if defined.

Example: A Major scale might have intervals [2, 2, 1, 2, 2, 2, 1].

§intervals_ascending: Option<Vec<u8>>

The non-standard ascending intervals of the scale in semitones, if distinct from the main intervals.

Example: For an Enigmatic scale, this might be [1, 3, 2, 2, 2, 1, 1].

§intervals_descending: Option<Vec<u8>>

The non-standard descending intervals of the scale in semitones, if distinct from the main intervals.

Example: For an Enigmatic scale, this might be [1, 3, 1, 3, 2, 1, 1].

§notes: Option<Vec<u8>>

The notes of the scale, expressed as offset from root, if defined.

Example: A C Major scale might have notes [0, 2, 4, 5, 7, 9, 11] corresponding to C, D, E, F, G, A, B.

§notes_ascending: Option<Vec<u8>>

The non-standard ascending notes of the scale, if distinct.

Example: For an Enigmatic scale, this might be [0, 1, 4, 6, 8, 10, 11].

§notes_descending: Option<Vec<u8>>

The non-standard descending notes of the scale, if distinct.

Example: For an Enigmatic scale, this might be [0, 1, 4, 5, 8, 10, 11].

§origin: Option<String>

The origin or cultural association of the scale, if available.

Example: A scale might have an origin like "Egypt" or "India".

Trait Implementations§

Source§

impl Clone for Scale

Source§

fn clone(&self) -> Scale

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
Source§

impl Debug for Scale

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Scale

Source§

fn eq(&self, other: &Scale) -> 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.
Source§

impl Eq for Scale

Source§

impl StructuralPartialEq for Scale

Auto Trait Implementations§

§

impl Freeze for Scale

§

impl RefUnwindSafe for Scale

§

impl Send for Scale

§

impl Sync for Scale

§

impl Unpin for Scale

§

impl UnwindSafe for Scale

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.