Skip to main content

Specifier

Enum Specifier 

Source
pub enum Specifier {
    Perfect = 1,
    Major = 2,
    Minor = 3,
    Augmented = 4,
    Diminished = 5,
    DoubleAugmented = 6,
    DoubleDiminished = 7,
    TripleAugmented = 8,
    TripleDiminished = 9,
    QuadrupleAugmented = 10,
    QuadrupleDiminished = 11,
}
Expand description

An interval quality, numbered as music21 numbers its Specifier enum.

Variants§

§

Perfect = 1

P

§

Major = 2

M

§

Minor = 3

m

§

Augmented = 4

A

§

Diminished = 5

d

§

DoubleAugmented = 6

AA

§

DoubleDiminished = 7

dd

§

TripleAugmented = 8

AAA

§

TripleDiminished = 9

ddd

§

QuadrupleAugmented = 10

AAAA

§

QuadrupleDiminished = 11

dddd

Implementations§

Source§

impl Specifier

Source

pub const ALL: [Specifier; 11]

Every specifier, in music21’s numbering order.

Source

pub fn value(self) -> IntegerType

music21’s number for the specifier, 1 for perfect through 11.

Source

pub fn from_value(value: IntegerType) -> Result<Self>

The specifier with music21’s number, if there is one.

Source

pub fn nice_name(&self) -> String

Returns a human-friendly name for the specifier, music21’s niceName.

Source

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

Parses a specifier the way music21’s parseSpecifier does: a prefix such as "P", "m" or "AA", or a spelled-out name such as "Perfect" or "Doubly-Augmented".

Case is significant only for m/M: minor and major are the one pair where both spellings already denote different intervals. Every other specifier accepts either case, which is exactly the distinction music21 draws — a2/A2, d5/D5, p5/P5 and the doubled and tripled forms all parse there, while m3 and M3 stay distinct. Lowercasing the input wholesale would silently turn every major third minor.

Source

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

Returns the prefix music21 writes before the interval number, such as "P", "m" or "AA".

Source

pub fn inversion(&self) -> Self

The specifier of the inverted interval: major becomes minor, augmented becomes diminished, perfect stays perfect.

Source

pub fn semitones_above_perfect(&self) -> Result<IntegerType>

How many semitones above perfect the specifier lies. Major and minor cannot be compared to perfect and are an error, as in music21.

Source

pub fn semitones_above_major(&self) -> Result<IntegerType>

How many semitones above major the specifier lies. Perfect cannot be compared to major and is an error, as in music21.

Source

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

music21’s enum member name, PERFECT, DBLAUG, QUADDIM.

Trait Implementations§

Source§

impl Clone for Specifier

Source§

fn clone(&self) -> Specifier

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Specifier

Source§

impl Debug for Specifier

Source§

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

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

impl<'de> Deserialize<'de> for Specifier

Available on crate feature serde only.
Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for Specifier

Source§

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

The prefix, as str(Specifier.PERFECT) is P in music21.

Source§

impl Eq for Specifier

Source§

impl FromStr for Specifier

Source§

type Err = Error

The associated error which can be returned from parsing.
Source§

fn from_str(name: &str) -> Result<Self>

Parses a string s to return a value of this type. Read more
Source§

impl Hash for Specifier

Source§

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

impl PartialEq for Specifier

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for Specifier

Available on crate feature serde only.
Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Specifier

Auto Trait Implementations§

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<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> IntoEither for T

Source§

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

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

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.