Struct Variant 

pub struct Variant { /* private fields */ }

Another reading of a passage: music21’s Variant.

use music21_rs::variant::{LengthType, Variant};
use music21_rs::{Duration, Note};

let mut variant = Variant::named("ossia");
variant.contents_mut().push(Note::from_name("D4")?.with_duration(Duration::half()));
assert_eq!(variant.groups(), ["ossia"]);
assert_eq!(variant.replacement_quarter_length(), 2.0);

variant.set_replacement_quarter_length(Some(4.0));
assert_eq!(variant.length_type(), LengthType::Deletion);

Implementations

impl Variant

pub fn new() -> Self

A variant holding nothing, in no group.

pub fn named(name: impl Into<String>) -> Self

A variant holding nothing, in the one group name: music21’s Variant(name=...).

pub fn from_stream(contents: Stream) -> Self

A variant holding a stream’s elements where they stand in it.

pub fn contents(&self) -> &Stream

The reading the variant holds: music21’s containedSite.

pub fn contents_mut(&mut self) -> &mut Stream

The same, to change.

pub fn groups(&self) -> &[String]

The names of the readings the variant belongs to: music21’s groups.

pub fn groups_mut(&mut self) -> &mut Vec<String>

The same, to change.

pub fn replacement_quarter_length(&self) -> FloatType

How much of the stream holding it the variant stands in for: the length set, or what the reading lasts: music21’s replacementQuarterLength.

pub fn set_replacement_quarter_length(&mut self, length: Option<FloatType>)

Sets how much of the stream the variant stands in for, or with None makes it what the reading lasts.

pub fn contained_highest_time(&self) -> FloatType

When the last thing the reading holds ends: music21’s containedHighestTime.

pub fn contained_highest_offset(&self) -> FloatType

Where the last thing the reading holds starts: music21’s containedHighestOffset.

pub fn length_type(&self) -> LengthType

Whether the reading is as long as what it stands in for, longer or shorter: music21’s lengthType.

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

The variant with its reading transposed.

Errors

As Stream::transpose.

Trait Implementations

impl Clone for Variant

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 Variant

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

Formats the value using the given formatter.

impl Default for Variant

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Variant

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

fn from(variant: Variant) -> Self

Converts to this type from the input type.

impl Serialize for Variant

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.