Struct Microtone 

pub struct Microtone { /* private fields */ }

A microtonal pitch adjustment measured in cents, optionally shifted by a harmonic like Python music21’s music21.pitch.Microtone.

Implementations

impl Microtone

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

Creates a microtone with no harmonic shift.

pub fn with_harmonic_shift( specifier: impl Into<MicrotoneSpecifier>, harmonic_shift: IntegerType, ) -> Result<Self>

Creates a microtone with an explicit harmonic shift.

pub fn alter(&self) -> FloatType

Returns the microtone in accidental alter units, where 100 cents is 1.0.

pub fn cents(&self) -> FloatType

Returns the total cent displacement, including harmonic shift.

pub fn cent_shift(&self) -> FloatType

Returns the direct cent shift before harmonic adjustment.

pub fn set_cent_shift(&mut self, cents: FloatType)

Sets the direct cent shift before harmonic adjustment.

pub fn harmonic_shift(&self) -> IntegerType

Returns the harmonic shift.

pub fn set_harmonic_shift(&mut self, harmonic_shift: IntegerType)

Sets the harmonic shift.

Trait Implementations

impl Clone for Microtone

fn clone(&self) -> Microtone

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Microtone

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Microtone

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Microtone

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

Formats the value using the given formatter.

impl From<Microtone> for MicrotoneSpecifier

fn from(value: Microtone) -> Self

Converts to this type from the input type.

impl FromStr for Microtone

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 Microtone

fn eq(&self, other: &Self) -> 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 Microtone

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 Microtone

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 Microtone

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<f64> for Microtone

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 Microtone

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.