Struct Syllable

pub struct Syllable<'a> {
    pub text: &'a str,
    pub music: Vec<NoteElem<'a>>,
}

Struct representing a gabc syllable with text and music, e.g. “Po(eh/hi)”

Fields

text: &'a str

Text part of the syllable

music: Vec<NoteElem<'a>>

Music part of the syllable

Implementations

impl<'a> Syllable<'a>

pub fn new<'b>(gabc_input: &'b str, current_clef: &'b str) -> Syllable<'b>

Create a new syllable from well-formed gabc input.

Examples

let s = Syllable::new("Po(eh/hi)", "c3");
assert_eq!(s.text, "Po");
assert_eq!(s.music.len(), 5);

pub fn ly_notes(&self) -> String

Translate this syllable’s music string into a tied sequence of Lilypond notes.

Examples

let s = Syllable::new("Po(eh/hi)", "c3");
assert_eq!(s.ly_notes(), "g(c' c' d')");

pub fn ly_text(&self) -> String

Translate this syllable’s text into valid Lilypond lyrics. If there are no Notes in this syllable’s music string, add “\set stanza = “ to prevent Lilypond matching this text to a note.

Examples

let s = Syllable::new("*()", "c3");
assert_eq!(s.ly_text(), " \\set stanza = \"*\" ");

Trait Implementations

impl<'a> Debug for Syllable<'a>

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

Formats the value using the given formatter.

impl<'a> Serialize for Syllable<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.