Enum Accidental

pub enum Accidental {
    None,
    DoubleFlat,
    Flat,
    Natural,
    Sharp,
    DoubleSharp,
}

Represents an accidental.

Examples

use note_pen::prelude::*;
let sharp = Accidental::Sharp;
let note = Note::new(Alphabet::A, sharp, 4);
let next_note = sharp + note;
assert_eq!(next_note, Note::new(Alphabet::A, Accidental::DoubleSharp, 4));
assert_eq!(sharp + note, Note::new(Alphabet::B, Accidental::default(), 4));

Variants

None

DoubleFlat

Flat

Natural

Sharp

DoubleSharp

Implementations

impl Accidental

pub const fn unicode(&self) -> &'static str

Trait Implementations

impl Add<Note> for Accidental

type Output = Note

The resulting type after applying the + operator.

fn add(self, rhs: Note) -> Self::Output

Performs the + operation.

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 Hash for Accidental

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Accidental

fn eq(&self, other: &Accidental) -> 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 Copy for Accidental

impl Eq for Accidental

impl StructuralPartialEq for Accidental