Struct PitchClass 

pub struct PitchClass { /* private fields */ }

A normalized pitch-class value.

Pitch classes wrap into the range 0 <= pc < 12. Integer pitch classes display using music21’s hexadecimal-style spellings: A for 10 and B for 11.

Implementations

impl PitchClass

pub fn new(specifier: impl Into<PitchClassSpecifier>) -> Result<Self>

Creates a normalized pitch class from a number, string, or existing pitch class.

pub fn number(&self) -> FloatType

Returns the normalized numeric pitch class.

pub fn integer(&self) -> Option<IntegerType>

Returns the integer pitch class if this value is not microtonal.

pub fn string(&self) -> String

Returns the music21-style pitch-class string.

Trait Implementations

impl Clone for PitchClass

fn clone(&self) -> PitchClass

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PitchClass

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PitchClass

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PitchClass

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

Formats the value using the given formatter.

impl From<PitchClass> for PitchClassSpecifier

fn from(value: PitchClass) -> Self

Converts to this type from the input type.

impl FromStr for PitchClass

type Err = Error

The associated error which can be returned from parsing.

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

Parses a string s to return a value of this type.

impl PartialEq for PitchClass

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for PitchClass

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self>

Performs the conversion.

impl TryFrom<String> for PitchClass

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self>

Performs the conversion.

impl TryFrom<char> for PitchClass

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: char) -> Result<Self>

Performs the conversion.

impl TryFrom<f64> for PitchClass

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: FloatType) -> Result<Self>

Performs the conversion.

impl TryFrom<i32> for PitchClass

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: IntegerType) -> Result<Self>

Performs the conversion.

impl TryFrom<u8> for PitchClass

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: u8) -> Result<Self>

Performs the conversion.

impl Copy for PitchClass

impl StructuralPartialEq for PitchClass