Struct ReductiveParameters 

pub struct ReductiveParameters {
    pub pitch: Option<String>,
    pub octave: Option<String>,
    pub notehead_fill: Option<String>,
    pub stem_direction: Option<String>,
    pub group: Option<String>,
    pub voice: Option<String>,
    pub text_above: Option<String>,
    pub text_below: Option<String>,
}

How a lyric marks its note for a reduction: music21’s ReductiveNote parameters, each as the lyric writes it. The keys are p for the pitch taken from a chord, o the octave, nf the notehead fill, sd the stem direction, g the group, v the voice, ta text above and tb text below.

Fields

pitch: Option<String>

The pitch name taken from a chord: p.

octave: Option<String>

The octave the note is written in: o.

notehead_fill: Option<String>

Whether the notehead is filled: nf, yes or no or a fill music21 names.

stem_direction: Option<String>

Which way the stem points: sd, no stem unless said.

group: Option<String>

The group whose part the note goes in: g.

voice: Option<String>

The voice the note goes in: v.

text_above: Option<String>

Text written above the note: ta.

text_below: Option<String>

Text written below the note, as a lyric: tb.

Implementations

impl ReductiveParameters

pub fn parse(spec: &str) -> Result<Option<Self>>

The parameters a lyric says, or nothing for a lyric that does not start ::. Each /-separated key:value after the first sets the parameter the key names; one naming none is passed over, as is anything without a :. The stem direction is noStem unless said.

Errors

A key written in capitals, which music21 recognizes but cannot look up, or an argument with more than one :.

Trait Implementations

impl Clone for ReductiveParameters

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReductiveParameters

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

Formats the value using the given formatter.

impl Default for ReductiveParameters

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ReductiveParameters

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 Eq for ReductiveParameters

impl PartialEq for ReductiveParameters

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ReductiveParameters

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 ReductiveParameters