Struct Placed 

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

One element of a stream with its place in it: its offset, its offset in the measure holding it and that measure’s number, and the key signature, metre and tempo in force where it stands.

Implementations

impl<'a> Placed<'a>

pub fn element(&self) -> &'a StreamElement

The element itself.

pub fn offset(&self) -> FloatType

The offset from the start of the stream asked.

pub fn measure_offset(&self) -> Option<FloatType>

The offset from the start of the measure holding the element, or None outside any measure.

pub fn measure_number(&self) -> Option<IntegerType>

The number of the innermost measure holding the element, or None outside any measure: music21’s measureNumber.

pub fn key_signature(&self) -> Option<&'a KeySignature>

The key signature in force where the element stands.

pub fn time_signature(&self) -> Option<&'a TimeSignature>

The metre in force where the element stands.

pub fn metronome_mark(&self) -> Option<&'a MetronomeMark>

The tempo in force where the element stands.

pub fn bar_offset(&self) -> Option<FloatType>

Where the element falls in the bar of the meter in force: music21’s getMeasureOffsetOrMeterModulusOffset. Inside a measure that is its place in it, padding included; outside one, the meter’s bars are counted on from where the meter stands. None with no meter.

  3/4 at 0, no measures:  note at 4.0  ->  bar offset 1.0
  4/4 pickup, padding 3:  note at 0.0  ->  bar offset 3.0

pub fn beat(&self) -> Result<Option<FloatType>>

The beat the element falls on, counted from 1 with the progress through it as a fraction: music21’s beat. None with no meter, where music21 answers nan.

Errors

An offset the meter cannot place, where music21 raises.

pub fn beat_string(&self) -> Result<Option<String>>

Placed::beat written as music21’s beatStr writes it: 2 1/2.

Errors

As Placed::beat.

pub fn beat_duration(&self) -> Result<Option<Duration>>

How long the beat holding the element is: music21’s beatDuration. None with no meter, where music21 answers a duration of nothing.

Errors

As Placed::beat.

pub fn beat_strength(&self) -> Result<Option<FloatType>>

The metrical accent of the element’s place: music21’s beatStrength, which weighs a place that starts no partition at half the smallest weight. None with no meter.

Errors

As Placed::beat.

Trait Implementations

impl<'a> Clone for Placed<'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 Placed<'a>

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

Formats the value using the given formatter.