Struct Melody 

pub struct Melody {
    pub items: Vec<MelodyItem>,
}

A single monophonic line of notes and rests in sequence.

Fields

items: Vec<MelodyItem>

The ordered notes and rests of the line.

Implementations

impl Melody

pub fn new(items: Vec<MelodyItem>) -> Result<Self, MusicError>

Builds a melody, validating that every item duration is non-negative.

pub fn total_duration(&self) -> Time

Returns the summed duration of all items in the line.

Examples

use sim_lib_music_core::{Melody, MelodyItem, Rest, Time};

let melody = Melody::new(vec![
    MelodyItem::Rest(Rest::new(Time::from_integer(1)).unwrap()),
    MelodyItem::Rest(Rest::new(Time::from_integer(2)).unwrap()),
])
.unwrap();
assert_eq!(melody.total_duration(), Time::from_integer(3));

Trait Implementations

impl Clone for Melody

fn clone(&self) -> Melody

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Melody

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

Formats the value using the given formatter.

impl Eq for Melody

impl MusicObject for Melody

fn kind(&self) -> &'static str

Returns a stable, human-readable tag for this object kind.

fn duration(&self) -> Time

Returns the total duration this object occupies.

fn voices<'a>(&'a self, offset: Time, out: &mut Vec<TimedAtom<'a>>)

Appends the timed atoms produced by this object, shifted by offset.

fn clone_box(&self) -> Box<dyn MusicObject>

Clones this object into a fresh boxed trait object.

fn as_any(&self) -> &dyn Any

Returns this object as a &dyn Any for downcasting.

impl PartialEq for Melody

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Melody