Enum ScalaDegree 

pub enum ScalaDegree {
    Ratio(Ratio),
    Cents(FloatType),
}

A single degree of a ScalaScale.

Scala files express each degree either as an exact ratio (3/2) or as a cents value (701.955). The distinction is preserved rather than collapsed, because a ratio carries exactness that cents cannot express.

Variants

Ratio(Ratio)

An exact ratio, such as 3/2. A Scala file writes only ratios of whole numbers, so this is always Ratio::Rational.

Cents(FloatType)

A cents value above the scale root, such as 701.955.

Implementations

impl ScalaDegree

pub fn ratio(self) -> FloatType

Returns this degree as a frequency ratio above the scale root.

pub fn cents(self) -> FloatType

Returns this degree in cents above the scale root.

pub fn as_ratio(self) -> Option<Ratio>

Returns the exact ratio, when this degree was written as one.

pub fn written(self) -> String

The line a Scala file writes for this degree: the other half of the reading FromStr does.

Scala tells the two spellings apart by the point: a value carrying one is cents and a value without one is a ratio, so a whole number of cents is written 1200.0 and never 1200, which would be a ratio of twelve hundred to one.

Trait Implementations

impl Clone for ScalaDegree

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ScalaDegree

impl Debug for ScalaDegree

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ScalaDegree

Available on crate feature serde only.

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ScalaDegree

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

Formats the value using the given formatter.

impl FromStr for ScalaDegree

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

Reads one note line of a Scala file: music21’s ScalaPitch.parse.

A value carrying a point is cents and one without is a ratio, n\m is n steps of m-EDO, and anything after the value is a comment.

type Err = Error

The associated error which can be returned from parsing.

impl PartialEq for ScalaDegree

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ScalaDegree

Available on crate feature serde only.

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ScalaDegree