Struct OffsetSpan 

pub struct OffsetSpan {
    pub start: FloatType,
    pub end: Option<FloatType>,
    pub include_end_boundary: bool,
    pub must_finish_in_span: bool,
    pub must_begin_in_span: bool,
    pub include_elements_that_end_at_start: bool,
}

A span of offsets to search, and which elements on its edges the search takes: music21’s getElementsByOffset and the keywords it reads.

Self::at searches one offset and Self::between a stretch. The four flags start as music21’s own defaults, so a span built by either answers what music21 answers with no keywords given.

Fields

start: FloatType

Where the span starts: offsetStart.

end: Option<FloatType>

Where it ends, or nothing for a span of no length at start: offsetEnd.

include_end_boundary: bool

Whether an element starting exactly where the span ends is taken: includeEndBoundary.

must_finish_in_span: bool

Whether an element sounding past the end of the span is left out: mustFinishInSpan.

must_begin_in_span: bool

Whether an element starting before the span is left out: mustBeginInSpan.

include_elements_that_end_at_start: bool

Whether an element ending exactly where the span starts is taken: includeElementsThatEndAtStart.

Implementations

impl OffsetSpan

pub fn at(offset: FloatType) -> Self

One offset, with music21’s defaults: a span of no length, which takes every element sounding across it and every mark standing on it.

pub fn between(start: FloatType, end: FloatType) -> Self

A stretch from one offset to another, with music21’s defaults.

impl OffsetSpan

pub fn takes_at(&self, offset: FloatType, quarter_length: FloatType) -> bool

Whether something standing at offset and lasting quarter_length is in the span: music21’s isElementOffsetInRange.

The decision turns on nothing else, which is why a caller holding its own elements – the Python package holds music21’s objects – can ask this of each rather than keep a second copy of the rules.

use music21_rs::stream::OffsetSpan;

// A half note at nought does not begin in a span of no length at
// 1, which is what music21's `mustBeginInSpan` asks by default.
let at_one = OffsetSpan::at(1.0);
assert!(!at_one.takes_at(0.0, 2.0));
assert!(at_one.takes_at(1.0, 1.0));

let mut sounding = OffsetSpan::at(1.0);
sounding.must_begin_in_span = false;
assert!(sounding.takes_at(0.0, 2.0));

Trait Implementations

impl Clone for OffsetSpan

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for OffsetSpan

impl Debug for OffsetSpan

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

Formats the value using the given formatter.

impl PartialEq for OffsetSpan

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for OffsetSpan