Struct Modifier 

pub struct Modifier { /* private fields */ }

The accidental written beside a figure: music21’s Modifier.

Figured bass has its own marks — a + raises and a / lowers — so the string it was written with is kept alongside the accidental it means.

Implementations

impl Modifier

pub fn new(written: Option<&str>) -> Result<Self>

Reads one, which may be nothing at all: neither None nor the empty string says anything about how the note is spelled.

pub fn written(&self) -> Option<&str>

The mark as it was written.

pub fn accidental(&self) -> Option<&Accidental>

The accidental it stands for, and nothing where nothing was written.

pub fn modify(&self, pitch: &Pitch) -> Result<Pitch>

The same note spelled as this modifier asks.

A written natural replaces whatever was there; anything else is added to it, so a sharp against a flattened note raises it to a natural.

pub fn modify_pitch_name(&self, name: &str) -> Result<String>

The name of a pitch spelled as this modifier asks: music21’s modifyPitchName, so a sharp makes D into D#.

Trait Implementations

impl Clone for Modifier

fn clone(&self) -> Modifier

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Modifier

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

Formats the value using the given formatter.

impl Default for Modifier

fn default() -> Modifier

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Modifier

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 Modifier

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

music21’s _reprInternal: the mark and the accidental it means.

impl PartialEq for Modifier

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Modifier

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 Modifier