Struct LyricSearcher 

pub struct LyricSearcher<'a> { /* private fields */ }

Finds text in a stream’s lyrics: music21’s LyricSearcher. Each verse’s lyrics are read as one text, syllables of a word run together and words apart, and the verses one after another with LINE_BREAK between them; a search finds each place the text comes and the lyrics and notes there.

use music21_rs::search::LyricSearcher;
use music21_rs::tinynotation::from_tiny_notation;

let line = from_tiny_notation("4/4 c4_Et d_in f_terra a_pax")?;
let searcher = LyricSearcher::new(&line);
assert_eq!(searcher.index_text(), "Et in terra pax");
let found = searcher.search("in ter")?;
assert_eq!(found[0].elements().len(), 2);

Implementations

impl<'a> LyricSearcher<'a>

pub fn new(stream: &'a Stream) -> Self

The lyrics of a stream, nested streams included, read with a space between words.

pub fn with_word_separator(stream: &'a Stream, word_separator: &str) -> Self

The lyrics of a stream read with this between words: music21’s LyricSearcher(s, wordSeparator=...), indexed as its index does.

pub fn index_text(&self) -> &str

The text searched: each verse’s lyrics, the verses joined with LINE_BREAK: music21’s indexText.

pub fn indexed(&self) -> &[IndexedLyric<'a>]

Every lyric with text and where it sits in Self::index_text: music21’s indexTuples.

pub fn search(&self, text: &str) -> Result<Vec<LyricMatch<'a>>>

Each place text comes in the lyrics, left to right, none overlapping the one before: music21’s search of a plain string.

Errors

A match that touches no lyric, which music21 refuses: one that lies wholly in the space between words or verses.

Trait Implementations

impl<'a> Clone for LyricSearcher<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for LyricSearcher<'a>

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

Formats the value using the given formatter.