Struct PitchOptions 

pub struct PitchOptions {
    pub name: Option<PitchName>,
    pub step: Option<char>,
    pub octave: Octave,
    pub accidental: Option<AccidentalSpecifier>,
    pub microtone: Option<MicrotoneSpecifier>,
    pub pitch_class: Option<PitchClassSpecifier>,
    pub midi: Option<IntegerType>,
    pub ps: Option<FloatType>,
    pub fundamental: Option<Pitch>,
}

Builder options for constructing a Pitch.

Fields

name: Option<PitchName>

Pitch name or pitch-space number.

step: Option<char>

Diatonic step name.

octave: Octave

Octave number.

accidental: Option<AccidentalSpecifier>

Accidental name or alteration.

microtone: Option<MicrotoneSpecifier>

Microtone cent offset.

pitch_class: Option<PitchClassSpecifier>

Pitch class to realize as a pitch.

midi: Option<IntegerType>

MIDI note number.

ps: Option<FloatType>

Pitch-space value.

fundamental: Option<Pitch>

Fundamental pitch used for harmonic construction.

Implementations

impl PitchOptions

pub fn new() -> Self

Creates an empty pitch builder.

pub fn name(self, name: impl Into<PitchName>) -> Self

Sets the pitch name or pitch-space number.

pub fn step(self, step: char) -> Self

Sets the diatonic step.

pub fn octave(self, octave: IntegerType) -> Self

Sets the octave.

pub fn accidental(self, accidental: impl Into<AccidentalSpecifier>) -> Self

Sets the accidental.

pub fn microtone(self, microtone: impl Into<MicrotoneSpecifier>) -> Self

Sets the microtone.

pub fn pitch_class(self, pitch_class: impl Into<PitchClassSpecifier>) -> Self

Sets the pitch class.

pub fn midi(self, midi: IntegerType) -> Self

Sets the MIDI note number.

pub fn ps(self, ps: FloatType) -> Self

Sets the pitch-space value.

pub fn pitch_space(self, pitch_space: FloatType) -> Self

Sets the pitch-space value.

pub fn fundamental(self, fundamental: Pitch) -> Self

Sets the fundamental pitch.

pub fn build(self) -> Result<Pitch>

Builds a Pitch from the collected options.

Trait Implementations

impl Clone for PitchOptions

fn clone(&self) -> PitchOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PitchOptions

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

Formats the value using the given formatter.

impl Default for PitchOptions

fn default() -> PitchOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PitchOptions

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PitchOptions

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

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 PitchOptions