Struct Lyric 

pub struct Lyric { /* private fields */ }

A syllable of text sung on a note: music21’s note.Lyric.

The hyphens in the written text say where the syllable falls in its word, which is why Self::from_raw_text reads "-ci-" as a middle syllable and Self::raw_text writes the hyphens back.

Implementations

impl Lyric

pub fn new(text: impl Into<String>) -> Self

A lyric on the first verse, spelled as a whole word.

pub fn unsung() -> Self

A lyric with nothing sung to it yet, which is music21’s bare Lyric(): it says nothing about where it falls in a word, and writing its text does not make it say so.

pub fn from_raw_text(raw_text: &str) -> Self

Reads a lyric from text whose hyphens say where it falls in its word: "-ci-" is a middle syllable, "ci-" a beginning, "-us" an end.

pub fn text(&self) -> String

The syllable without its hyphens.

A composite lyric has no text of its own: it reads as its components run together, each joined on by its own Self::elision_before.

pub fn set_text(&mut self, text: impl Into<String>)

Replaces the syllable text, leaving its position in the word alone.

Setting the text of a composite lyric drops its components, which is what music21 does: the text you gave it is now the whole of it.

pub fn explicit_text(&self) -> Option<String>

The syllable as music21’s text reads it, which may be nothing at all: music21 starts a lyric off sung to the empty string, and setting its text to nothing is how a score says the syllable was taken away.

pub fn clear_text(&mut self)

Takes the text away, leaving a lyric with nothing sung to it at all — which music21 tells apart from one sung to the empty string, and writes out as neither.

pub fn is_composite(&self) -> bool

Whether this lyric is several lyrics sung together rather than one syllable: music21’s isComposite.

pub fn components(&self) -> &[Lyric]

The lyrics this one is made of, empty unless it is composite.

pub fn set_components(&mut self, components: Vec<Lyric>)

Makes this lyric the several lyrics given, run together. An empty list makes it an ordinary one again, keeping the text it had.

pub fn elision_before(&self) -> &str

What joins this syllable to the one before it inside a composite lyric — a space by default, an underscore for an elision.

pub fn set_elision_before(&mut self, elision: impl Into<String>)

Sets what joins this syllable to the one before it.

pub fn number(&self) -> IntegerType

The verse number, counting from one.

pub fn set_number(&mut self, number: IntegerType)

Sets the verse number, which must be positive as music21 requires. Sets which verse this lyric belongs to.

Any whole number will do, as music21’s own setter allows: its MusicXML reader numbers a verse 0 when the score named it with something that is not a number at all, and keeps the name as the identifier.

pub fn syllabic(&self) -> Syllabic

Where the syllable falls in its word. A composite lyric reads as Syllabic::Composite whatever it was set to.

pub fn explicit_syllabic(&self) -> Option<Syllabic>

The same, where something has actually said it: music21 leaves it unset on a lyric nobody has sung anything to.

pub fn set_syllabic(&mut self, syllabic: Syllabic)

Sets where the syllable falls in its word.

pub fn identifier(&self) -> String

The name this verse goes by, which music21 falls back to the number for when none was given.

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

The name this verse was given, and nothing when it goes by its number. music21’s identifier answers the number itself in that case, which is a different type, so a caller that cares asks here.

pub fn set_identifier(&mut self, identifier: Option<String>)

Names this verse, or clears the name so the number stands in.

pub fn raw_text(&self) -> String

The syllable written with the hyphens its position implies.

A composite lyric takes its hyphens from the ends of the run: the first component decides whether one leads, the last whether one trails.

pub fn set_raw_text(&mut self, raw_text: &str)

Reads the syllable and its position out of hyphenated text. Like Self::set_text, this drops any components.

pub fn set_text_and_syllabic(&mut self, raw_text: &str, apply_raw: bool)

music21’s setTextAndSyllabic: Self::set_raw_text, unless apply_raw says the hyphens are the text itself. Then nothing about the word is read out of them and the position stands as it was, except that a lyric that had said nothing about where it falls is now a whole word. Either way drops any components.

Trait Implementations

impl Clone for Lyric

fn clone(&self) -> Lyric

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Lyric

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Lyric

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 Display for Lyric

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

Formats the value using the given formatter.

impl Eq for Lyric

impl Hash for Lyric

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Lyric

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Lyric

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 Lyric