Struct Stream 

pub struct Stream { /* private fields */ }

An ordered stream of music, which may hold other streams.

Implementations

impl Stream

pub fn new() -> Self

Creates an empty stream.

pub fn with_kind(kind: StreamKind) -> Self

Creates an empty stream standing for one of music21’s subclasses.

pub fn kind(&self) -> StreamKind

Which of music21’s Stream subclasses this stands for.

pub fn set_kind(&mut self, kind: StreamKind)

Sets which subclass this stands for.

pub fn from_events(events: impl IntoIterator<Item = StreamEvent>) -> Self

Creates a stream from events, sorted by offset.

pub fn insert(&mut self, offset: FloatType, element: impl Into<StreamElement>)

Inserts an element at a quarter-length offset.

pub fn push(&mut self, element: impl Into<StreamElement>)

Appends an element after the current end of the stream.

pub fn events_mut(&mut self) -> &mut [StreamEvent]

Returns immutable events in offset order.

pub fn events(&self) -> &[StreamEvent]

The events in offset order.

pub fn iter(&self) -> impl Iterator<Item = &StreamEvent>

Iterates over events in offset order.

pub fn len(&self) -> usize

How many events this stream holds directly, not counting what any nested stream holds.

pub fn is_empty(&self) -> bool

Whether this stream holds nothing at all.

pub fn flatten(&self) -> Self

One timeline with the nesting dissolved: music21’s flatten.

Each nested stream’s offset is added to its contents’, and the streams themselves are gone; everything else comes through in offset order.

pub fn recurse(&self) -> Vec<(FloatType, &StreamElement)>

Every element at its offset from this stream’s start, nested streams themselves included: music21’s recurse.

pub fn streams_of_kind(&self, kind: StreamKind) -> Vec<&Stream>

The streams of one kind held directly by this one: music21’s .parts on a score, .measures on a part, .voices on a measure.

pub fn parts(&self) -> Vec<&Stream>

The parts this stream holds.

pub fn measures(&self) -> Vec<&Stream>

The measures this stream holds.

pub fn voices(&self) -> Vec<&Stream>

The voices this stream holds.

pub fn notes(&self) -> Vec<(FloatType, StreamElement)>

Every note and chord on the flattened timeline: music21’s flatten().notes, which leaves rests out.

pub fn end_offset(&self) -> FloatType

Returns the maximum event end offset, a nested stream’s own length included.

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

Returns all pitches in timeline order, from nested streams too.

pub fn key_signature_at(&self, offset: FloatType) -> Option<KeySignature>

The key signature in force at an offset: the last one written at or before it, anywhere in the nesting.

This is what music21 answers with getContextByClass(KeySignature), found by looking back along the flattened timeline rather than by walking the sites an object belongs to.

pub fn time_signature_at(&self, offset: FloatType) -> Option<TimeSignature>

The metre in force at an offset, found the same way.

pub fn metronome_mark_at(&self, offset: FloatType) -> Option<MetronomeMark>

The tempo in force at an offset, found the same way.

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

Returns a transposed copy, nesting and all.

Trait Implementations

impl Clone for Stream

fn clone(&self) -> Stream

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Stream

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

Formats the value using the given formatter.

impl Default for Stream

fn default() -> Stream

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Stream

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<Stream> for StreamElement

fn from(value: Stream) -> Self

Converts to this type from the input type.

impl<'a> IntoIterator for &'a Stream

type Item = &'a StreamEvent

The type of the elements being iterated over.

type IntoIter = Iter<'a, StreamEvent>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Serialize for Stream

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.