Struct StreamSearcher 

pub struct StreamSearcher {
    pub search: Vec<SearchTerm>,
    pub recurse: bool,
    pub filter: Option<Filter>,
    pub algorithms: Vec<Algorithm>,
}

Searches a stream for runs of elements matching a list of terms, the terms compared by a list of algorithms: music21’s StreamSearcher. A run matches unless an algorithm says one of its elements does not; with only the wildcard algorithm, as it starts, every run matches.

use music21_rs::duration::Duration;
use music21_rs::note::Note;
use music21_rs::search::{Algorithm, Filter, SearchTerm, StreamSearcher};
use music21_rs::stream::StreamElement;
use music21_rs::tinynotation::from_tiny_notation;

let line = from_tiny_notation("3/4 c4. d8 e4 g4. a8 f4 c'8 d'4.")?;
let mut searcher = StreamSearcher::new(vec![
    SearchTerm::Element(StreamElement::Note(
        Note::from_name("C4")?.with_duration(Duration::new(1.5)?),
    )),
    SearchTerm::Element(StreamElement::Note(
        Note::from_name("C4")?.with_duration(Duration::new(0.5)?),
    )),
]);
searcher.recurse = true;
searcher.filter = Some(Filter::Notes);
searcher.algorithms.push(Algorithm::Rhythm);
let found = searcher.run(&line)?;
assert_eq!(found.iter().map(|found| found.index).collect::<Vec<_>>(), [0, 3]);

Fields

search: Vec<SearchTerm>

What to look for, in order.

recurse: bool

Whether to look inside the streams the stream holds.

filter: Option<Filter>

Which elements to look at; all of them for none.

algorithms: Vec<Algorithm>

How to compare, in order, each asked until one answers.

Implementations

impl StreamSearcher

pub fn new(search: Vec<SearchTerm>) -> Self

A search for these terms, of the stream’s own elements, by the wildcard algorithm alone.

pub fn run<'a>(&self, stream: &'a Stream) -> Result<Vec<SearchMatch<'a>>>

The runs of a stream’s elements that match: music21’s run.

Errors

Nothing to search for.

pub fn run_over<'a>( &self, elements: &[Searched<'a>], ) -> Result<Vec<SearchMatch<'a>>>

The runs of these elements that match: music21’s run of a stream iterator.

Errors

Nothing to search for.

Trait Implementations

impl Clone for StreamSearcher

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 StreamSearcher

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

Formats the value using the given formatter.