Struct Rest 

pub struct Rest { /* private fields */ }

A silent musical event with a duration.

A rest may still carry words: a syllable written under a rest is how a score says a line is spoken there, or how a verse number sits at the start of a phrase that opens on a rest. music21 writes the lyric methods once on GeneralNote, and a rest has them as a note does.

Two rests are equal when they last as long; what is written under them does not count, as it does not in music21.

Implementations

impl Rest

pub fn new(duration: Duration) -> Self

Creates a rest with the supplied duration.

pub fn full_measure(&self) -> Option<bool>

Whether the rest stands for the whole of its measure, however long it is written: music21’s fullMeasure, nothing for its auto. The MusicXML reader says so where music21’s does.

pub fn set_full_measure(&mut self, full_measure: Option<bool>)

Says whether the rest stands for the whole of its measure.

pub fn grace_note(&self, appoggiatura: bool) -> Self

This rest written as a grace note’s value and lasting no time: music21’s getGrace, which a rest has as a note does.

pub fn tie(&self) -> Option<&Tie>

The tie written on the rest, which music21 lets a rest carry and a score now and then writes.

pub fn set_tie(&mut self, tie: Option<Tie>)

Writes a tie on the rest, or takes it off.

pub fn size(&self) -> Option<NoteSize>

How large the rest is drawn, where a score says, as a cue part’s rests are drawn small.

pub fn set_size(&mut self, size: Option<NoteSize>)

Says how large the rest is drawn.

pub fn step_shift(&self) -> IntegerType

How many staff steps above the middle line the rest is drawn, below where negative: music21’s stepShift, which a score uses to keep one voice’s rests out of another’s way.

pub fn set_step_shift(&mut self, shift: IntegerType)

Says how many staff steps from the middle line it is drawn.

pub fn expressions(&self) -> &[Expression]

The fermatas and other marks written over the rest: music21’s expressions, which a rest has as a note does.

pub fn expressions_mut(&mut self) -> &mut Vec<Expression>

The same, to be changed.

pub fn articulations(&self) -> &[Articulation]

The articulations written on the rest: music21’s articulations.

pub fn articulations_mut(&mut self) -> &mut Vec<Articulation>

The same, to be changed.

pub fn hidden(&self) -> bool

Whether it is left off the printed page, keeping its place and its time: music21’s style.hideObjectOnPrint, which a score uses for a rest that only fills out a voice.

pub fn set_hidden(&mut self, hidden: bool)

Says whether it is left off the printed page.

pub fn from_quarter_length(quarter_length: FloatType) -> Result<Self>

Creates a rest from a quarter-length value.

pub fn duration(&self) -> &Duration

Returns the rest duration.

pub fn set_duration(&mut self, duration: Duration)

Updates the rest duration.

pub fn quarter_length(&self) -> FloatType

Returns the duration in quarter lengths.

pub fn full_name(&self) -> String

The most complete name of the rest, its length included: music21’s fullName, Dotted Quarter Rest.

pub fn lyrics(&self) -> &[Lyric]

The syllables written under the rest, one per verse.

pub fn lyrics_mut(&mut self) -> &mut Vec<Lyric>

The syllables written under the rest, for editing in place.

pub fn lyric(&self) -> Option<String>

The text of every verse, one per line: music21’s lyric.

pub fn set_lyric(&mut self, lyric: Option<&str>)

Replaces every verse with one per line of the text, or clears them with None: music21’s lyric setter.

pub fn add_lyric( &mut self, text: &str, number: Option<IntegerType>, apply_raw: bool, )

Adds a syllable as a verse: music21’s addLyric, which a rest has as a note has it. See crate::Note::add_lyric.

pub fn insert_lyric(&mut self, text: &str, index: usize, apply_raw: bool)

Puts a syllable in front of the verse at index: music21’s insertLyric.

Trait Implementations

impl Clone for Rest

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 Rest

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

Formats the value using the given formatter.

impl Default for Rest

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Rest

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<Duration> for Rest

fn from(value: Duration) -> 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 PartialEq for Rest

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Rest

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.