Struct Dynamic 

pub struct Dynamic { /* private fields */ }

A dynamic mark and the loudness it stands for.

use music21_rs::Dynamic;

let forte = Dynamic::new("f");
assert_eq!(forte.volume_scalar(), 0.7);
assert_eq!(forte.long_name(), Some("forte"));

// A mark with no loudness of its own is read without its `s` and `z`.
assert_eq!(Dynamic::new("sfz").volume_scalar(), 0.7);

// A loudness names the mark it falls under and keeps its own value.
let soft = Dynamic::from_scalar(0.4)?;
assert_eq!(soft.value(), "mp");
assert_eq!(soft.volume_scalar(), 0.4);

Implementations

impl Dynamic

pub fn new(value: impl Into<String>) -> Self

A dynamic from its mark. Any text is a mark, as it is upstream; one music21 has no loudness for sounds at the middle of the range.

pub fn placement(&self) -> Option<Placement>

Which side of the staff it is written on, where the score says.

pub fn set_placement(&mut self, placement: Option<Placement>)

Says which side of the staff it is written on.

pub fn from_scalar(scalar: FloatType) -> Result<Self>

A dynamic from a loudness between nought and one, named as the mark that loudness falls under and keeping the loudness itself.

pub fn value(&self) -> &str

The mark as written, mf.

pub fn set_value(&mut self, value: impl Into<String>)

Writes another mark. A loudness a caller gave is kept.

pub fn long_name(&self) -> Option<&'static str>

The Italian word for the mark, mezzoforte, where music21 has one.

pub fn english_name(&self) -> Option<&'static str>

What the mark means in English, where music21 says.

pub fn volume_scalar(&self) -> FloatType

The loudness the dynamic stands for, between nought and one: music21’s volumeScalar.

The one a caller gave, else the mark’s own. A mark with none of its own is tried again without a leading letter where it has an s in it and without a closing z, so sfz is as loud as f; failing that it is the middle of the range.

pub fn set_volume_scalar(&mut self, scalar: FloatType) -> Result<()>

Gives the dynamic a loudness of its own, overriding its mark’s.

Trait Implementations

impl Clone for Dynamic

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 Dynamic

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Dynamic

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 Display for Dynamic

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

Formats the value using the given formatter.

impl From<Dynamic> for StreamElement

fn from(value: Dynamic) -> Self

Converts to this type from the input type.

impl PartialEq for Dynamic

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Dynamic

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.

impl StructuralPartialEq for Dynamic