Struct CtSong 

pub struct CtSong { /* private fields */ }

A song as its text says: music21’s CTSong.

Implementations

impl CtSong

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

A song read from its text: music21’s parse, which keeps the lines that carry anything, each trimmed.

music21 takes a path as readily as a text, reading the file where the string holds no | and no S:; the library reads no files, so this takes the text alone.

pub fn text(&self) -> &str

The text as it was read, its blank lines gone.

pub fn lines(&self) -> &[String]

The lines the text was read as.

pub fn title(&self) -> String

The title, which is the first line with its % taken off.

music21 takes every % out of that line rather than the one in front of it, so a title with a per cent in it loses the sign.

pub fn comments(&self) -> Vec<Vec<String>>

Every comment of the song but the title, each as music21 lists it: a comment on a rule’s line is that rule’s name and the comment, and one on a line of its own is the comment alone.

pub fn rules(&self) -> &[CtRule]

The rules of the song, in the order the text names them, the S: rule among them.

pub fn rule(&self, name: &str) -> Option<&CtRule>

The rule of a name, as music21 keys its rules by the left-hand side.

pub fn home_time_signature(&self) -> Result<Option<TimeSignature>>

The meter the song opens in: music21’s homeTimeSig, which reads the first two atoms of the S: rule – four-four where the first says no meter and no key, the meter where one says a meter, and nothing at all where both say a key.

Errors

A meter the crate cannot read.

pub fn home_key(&self) -> Result<Option<Key>>

The key the song opens in: music21’s homeKey, read the same way – C major where the first atom says neither, the key where one says a key, and nothing where both say a meter.

Errors

A key the crate cannot read.

pub fn to_part(&self) -> Result<Stream>

The song as a part: music21’s toPart, which expands the S: rule, numbers the measures from one and signs the part with the title.

Errors

As from_clercq_temperley.

pub fn to_part_with(&self, labels: CtLabels) -> Result<Stream>

The same, saying what to write under the chords.

Errors

As from_clercq_temperley.

Trait Implementations

impl Clone for CtSong

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 CtSong

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

Formats the value using the given formatter.

impl Default for CtSong

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CtSong

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 CtSong

impl PartialEq for CtSong

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for CtSong

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 CtSong