Enum StreamElement 

pub enum StreamElement {
    Note(Note),
    Chord(Chord),
    Rest(Rest),
    Stream(Box<Stream>),
    Clef(Clef),
    Instrument(Box<Instrument>),
    KeySignature(KeySignature),
    Key(Key),
    TimeSignature(TimeSignature),
    MetronomeMark(MetronomeMark),
    TempoText(TempoText),
    TextExpression(TextExpression),
    RepeatExpression(RepeatExpression),
    Dynamic(Dynamic),
    ChordSymbol(ChordSymbol),
    Unpitched(Unpitched),
    PercussionChord(PercussionChord),
    Barline(Barline),
    PedalObject(PedalObject),
    RehearsalMark(RehearsalMark),
    MetricModulation(Box<MetricModulation>),
    Break(Break),
    Layout(Layout),
    TextBox(Box<TextBox>),
    Variant(Box<Variant>),
}

A musical object that can live on a timeline.

Variants

Note(Note)

A single pitched note.

Chord(Chord)

A chord containing one or more notes.

Rest(Rest)

A silent rest.

Stream(Box<Stream>)

A stream nested inside this one: a part in a score, a measure in a part. Boxed, since a stream holds these by value.

Clef(Clef)

The clef in force from here on.

Instrument(Box<Instrument>)

The instrument playing from here on. Boxed: an instrument is large.

KeySignature(KeySignature)

The key signature in force from here on.

Key(Key)

The key in force from here on: a key signature that also says its tonic and mode, as music21’s Key is a KeySignature.

TimeSignature(TimeSignature)

The metre in force from here on.

MetronomeMark(MetronomeMark)

The tempo in force from here on.

TempoText(TempoText)

A tempo said in words, Grave or Allegro.

TextExpression(TextExpression)

Words written over or under the staff.

RepeatExpression(RepeatExpression)

A sign or words saying where to go next, Fine or D.C.

Dynamic(Dynamic)

The dynamic in force from here on.

ChordSymbol(ChordSymbol)

A chord named over the music. It holds for the time it has been given and takes none until then.

Unpitched(Unpitched)

A stroke with no pitch.

PercussionChord(PercussionChord)

Several strokes at once.

Barline(Barline)

A barline standing inside a measure rather than at either end of it, where a measure’s own barlines are kept.

PedalObject(PedalObject)

A bounce or a gap in the line of a held pedal, joined by the pedal mark it belongs to.

RehearsalMark(RehearsalMark)

A letter or number marking a place to rehearse from.

MetricModulation(Box<MetricModulation>)

A change of tempo written as one note value becoming another. Boxed: it holds two tempo marks.

Break(Break)

Where a manuscript’s line, page or column breaks.

Layout(Layout)

How the page, a system or a staff is laid out from here on.

TextBox(Box<TextBox>)

Text standing anywhere on a page. Boxed: it carries its style.

Variant(Box<Variant>)

Another reading of the passage starting here, which takes no time itself. Boxed: it holds a stream.

Implementations

impl StreamElement

pub fn music21_classes(&self) -> Vec<&'static str>

music21’s class names of the element, the most particular first, ending with Music21Object.

pub fn is_instance(&self, class: &str) -> bool

Whether the element is of a class, by music21’s name for it: music21’s isinstance by class name.

use music21_rs::{Note, StreamElement};

let note: StreamElement = Note::from_name("C4")?.into();
assert!(note.is_instance("NotRest"));
assert!(note.is_instance("GeneralNote"));
assert!(!note.is_instance("Rest"));

impl StreamElement

pub fn duration(&self) -> Option<&Duration>

Returns the assigned duration, if present.

The marks that only say what is in force from a point — a key, a metre, a tempo, a dynamic — have none, as they take no time in music21 either. A chord symbol has one, of no length until it is given the time it holds.

pub fn quarter_length(&self) -> FloatType

Returns the duration in quarter lengths.

A nested stream is as long as its own contents; a mark takes no time; anything else with no duration of its own defaults to a quarter, as music21’s does.

pub fn pitches(&self) -> Vec<Pitch>

Returns all pitches contained by this element, a nested stream’s included.

pub fn as_stream(&self) -> Option<&Stream>

The stream this element is, when it is one.

pub fn is_note_or_chord(&self) -> bool

Whether this element sounds — music21’s .notes, which is notes and chords but not rests.

pub fn transpose(&self, interval: &Interval) -> Result<Self>

Returns a transposed copy.

A key signature moves with the music, as music21’s does; a metre and a tempo do not depend on pitch and are left alone.

Trait Implementations

impl Clone for StreamElement

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 StreamElement

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StreamElement

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 From<Barline> for StreamElement

fn from(value: Barline) -> Self

Converts to this type from the input type.

impl From<Chord> for StreamElement

fn from(value: Chord) -> Self

Converts to this type from the input type.

impl From<ChordSymbol> for StreamElement

fn from(value: ChordSymbol) -> Self

Converts to this type from the input type.

impl From<Clef> for StreamElement

fn from(value: Clef) -> Self

Converts to this type from the input type.

impl From<Dynamic> for StreamElement

fn from(value: Dynamic) -> Self

Converts to this type from the input type.

impl From<Instrument> for StreamElement

fn from(value: Instrument) -> Self

Converts to this type from the input type.

impl From<Key> for StreamElement

fn from(value: Key) -> Self

Converts to this type from the input type.

impl From<KeySignature> for StreamElement

fn from(value: KeySignature) -> Self

Converts to this type from the input type.

impl From<MetricModulation> for StreamElement

fn from(value: MetricModulation) -> Self

Converts to this type from the input type.

impl From<MetronomeMark> for StreamElement

fn from(value: MetronomeMark) -> Self

Converts to this type from the input type.

impl From<Note> for StreamElement

fn from(value: Note) -> Self

Converts to this type from the input type.

impl From<PedalObject> for StreamElement

fn from(value: PedalObject) -> Self

Converts to this type from the input type.

impl From<PercussionChord> for StreamElement

fn from(value: PercussionChord) -> Self

Converts to this type from the input type.

impl From<RehearsalMark> for StreamElement

fn from(value: RehearsalMark) -> Self

Converts to this type from the input type.

impl From<RepeatExpression> for StreamElement

fn from(value: RepeatExpression) -> Self

Converts to this type from the input type.

impl From<Rest> for StreamElement

fn from(value: Rest) -> Self

Converts to this type from the input type.

impl From<Stream> for StreamElement

fn from(value: Stream) -> Self

Converts to this type from the input type.

impl From<StreamElement> for SearchTerm

fn from(element: StreamElement) -> Self

Converts to this type from the input type.

impl From<TempoText> for StreamElement

fn from(value: TempoText) -> Self

Converts to this type from the input type.

impl From<TextExpression> for StreamElement

fn from(value: TextExpression) -> Self

Converts to this type from the input type.

impl From<TimeSignature> for StreamElement

fn from(value: TimeSignature) -> Self

Converts to this type from the input type.

impl From<Unpitched> for StreamElement

fn from(value: Unpitched) -> Self

Converts to this type from the input type.

impl From<Variant> for StreamElement

fn from(variant: Variant) -> Self

Converts to this type from the input type.

impl Serialize for StreamElement

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.