Struct CtRule 

pub struct CtRule { /* private fields */ }

One rule of a song: music21’s CTRule, a line of the text.

Implementations

impl CtRule

pub fn new(text: &str) -> Self

A rule read from its line.

pub fn text(&self) -> &str

The line as it was written, its name and comment included.

pub fn left_hand_side(&self) -> &str

The name in front of the colon: music21’s LHS.

pub fn music_text(&self) -> &str

The chords alone, without the name or the comment: music21’s musicText.

pub fn comment(&self) -> Option<&str>

What was written after the %, if anything.

pub fn section_name(&self) -> String

The section the name stands for, as music21 spells the six it knows: In is an introduction, Br a bridge, Vr a verse, Ch a chorus, Tg a tag, S the song and Fadeout itself, with whatever follows the abbreviation kept.

pub fn measure_groups(&self) -> Vec<MeasureGroup>

The rule’s text as the groups it is read in: music21’s _measureGroups, where each group is a measure or the expansion of another rule, with how many times it is played.

pub fn expand(&self) -> Result<Vec<Stream>>

The measures the rule expands to on its own, in four-four and C major unless it says otherwise: music21’s expand on a rule with no song behind it, which writes the key and the meter into every measure it makes.

Errors

A rule expanding another, which only a song can answer, a dot with no chord before it, or a key, a meter or a figure the crate cannot read.

pub fn expand_in( &self, meter: Option<TimeSignature>, key: Option<Key>, ) -> Result<Vec<Stream>>

The same, in a key and a meter of the caller’s.

Errors

As CtRule::expand.

Trait Implementations

impl Clone for CtRule

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 CtRule

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

Formats the value using the given formatter.

impl Default for CtRule

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CtRule

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 CtRule

impl PartialEq for CtRule

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for CtRule

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 CtRule