Struct Accidental 

pub struct Accidental { /* private fields */ }

Symbolic and numerical accidental information for a pitch.

This mirrors the main behavior of Python music21’s music21.pitch.Accidental: a standard accidental has a name, modifier, and semitone alter; names compare by spelling while ordering uses alter.

Implementations

impl Accidental

pub fn new(specifier: impl Into<AccidentalSpecifier>) -> Result<Self>

Creates an accidental from a name, modifier, alternate name, unicode symbol, semitone alteration, or another accidental.

pub fn list_names() -> Vec<&'static str>

Returns the standard accidental names known to music21.

pub fn is_valid_name(name: &str) -> bool

Returns whether name is a supported accidental name, modifier, or alternate music21/LilyPond-style accidental name.

pub fn standardize_name(name: &str) -> Result<String>

Converts a supported accidental spelling to its standard music21 name.

pub fn set(&mut self, specifier: impl Into<AccidentalSpecifier>) -> Result<()>

Changes this accidental to a supported accidental.

pub fn set_allowing_non_standard_value( &mut self, specifier: impl Into<AccidentalSpecifier>, ) -> Result<()>

Changes this accidental, preserving non-standard names or alteration values in the same way Python music21’s allowNonStandardValue=True does.

pub fn name(&self) -> &str

Returns the standard or non-standard accidental name.

pub fn set_name(&mut self, name: impl Into<String>) -> Result<()>

Sets the accidental name. Standard names update alter and modifier; non-standard names are preserved without changing them.

pub fn alter(&self) -> FloatType

Returns the semitone alteration from the natural step.

pub fn set_alter(&mut self, alter: FloatType) -> Result<()>

Sets the semitone alteration. Standard values update name and modifier; non-standard values are preserved without changing them.

pub fn modifier(&self) -> &str

Returns the music21 modifier string, such as #, -, ##, or ~.

pub fn set_modifier(&mut self, modifier: impl Into<String>)

Sets the modifier. Unknown modifiers are preserved without changing the name or alteration, matching Python music21.

pub fn unicode(&self) -> String

Returns a unicode representation of the accidental.

pub fn full_name(&self) -> &str

Returns the most complete accidental name. This is currently the same as Self::name, like Python music21.

pub fn is_twelve_tone(&self) -> bool

Returns whether this accidental describes a twelve-tone alteration.

pub fn set_name_independently(&mut self, name: impl Into<String>)

Sets name without updating alter or modifier.

pub fn set_alter_independently(&mut self, alter: FloatType)

Sets alter without updating name or modifier.

pub fn set_modifier_independently(&mut self, modifier: impl Into<String>)

Sets modifier without updating name or alter.

pub fn inherit_display(&mut self, other: &Accidental)

Copies display-related settings from another accidental.

pub fn display_type(&self) -> &'static str

Returns the accidental display type.

pub fn set_display_type(&mut self, value: &str) -> Result<()>

Sets the accidental display type.

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

Returns whether notation processing has decided to display this accidental. None means no decision has been made.

pub fn set_display_status(&mut self, value: Option<bool>)

Sets the display status.

pub fn display_style(&self) -> &'static str

Returns the display style.

pub fn set_display_style(&mut self, value: &str) -> Result<()>

Sets the display style.

pub fn display_size(&self) -> String

Returns the display size.

pub fn set_display_size(&mut self, value: &str) -> Result<()>

Sets the display size.

pub fn display_location(&self) -> &'static str

Returns the display location.

pub fn set_display_location(&mut self, value: &str) -> Result<()>

Sets the display location.

pub fn natural() -> Accidental

Returns a natural accidental.

pub fn flat() -> Accidental

Returns a flat accidental.

pub fn sharp() -> Accidental

Returns a sharp accidental.

Trait Implementations

impl Clone for Accidental

fn clone(&self) -> Accidental

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Accidental

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

Formats the value using the given formatter.

impl Default for Accidental

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Accidental

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Accidental

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

Formats the value using the given formatter.

impl From<Accidental> for AccidentalSpecifier

fn from(value: Accidental) -> Self

Converts to this type from the input type.

impl FromStr for Accidental

type Err = Error

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Self>

Parses a string s to return a value of this type.

impl PartialEq for Accidental

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Accidental

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Accidental

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for Accidental

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self>

Performs the conversion.

impl TryFrom<String> for Accidental

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self>

Performs the conversion.

impl TryFrom<f64> for Accidental

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: FloatType) -> Result<Self>

Performs the conversion.

impl TryFrom<i32> for Accidental

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: IntegerType) -> Result<Self>

Performs the conversion.

impl TryFrom<i8> for Accidental

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: i8) -> Result<Self>

Performs the conversion.