Enum Note

pub enum Note {
    C,
    CSharp,
    D,
    DSharp,
    E,
    F,
    FSharp,
    G,
    GSharp,
    A,
    ASharp,
    B,
}

Identifies some note for a Key

Example

let note = Note::FSharp;


let key = note.with_octave(Octave::new(4));


assert_eq!(key.octave().value(), 4);
assert_eq!(key.note(), Note::FSharp);

Variants

C

CSharp

D

DSharp

E

F

FSharp

G

GSharp

A

ASharp

B

Implementations

impl Note

pub fn all() -> [Note; 12]

Returns an array beginning with Note::C to Note::B

pub fn new<K, E>(key: K) -> Result<Self, Error>

where K: TryInto<DataByte, Error = E>, E: Into<Error>,

Create a new note from a byte with a leading 0

Errors

if the byte is > 127

pub fn is_sharp(&self) -> bool

Returns true if the note type is sharp. Same as is_flat

Example

let note = Note::C;
assert!(!note.is_sharp());
let note = Note::FSharp;
assert!(note.is_sharp());

pub fn is_flat(&self) -> bool

Returns true if the note type is flat. Same as is_sharp

Example

let note = Note::A;
assert!(!note.is_flat());
let note = Note::CSharp;
assert!(note.is_flat());

pub fn from_data_byte(key: &DataByte) -> Self

Identify the note from a key byte.

pub fn with_octave(self, octave: Octave) -> Key

Create a Key given this note and a provided Octave

Trait Implementations

impl Clone for Note

fn clone(&self) -> Note

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Note

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

Formats the value using the given formatter.

impl Display for Note

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

Formats the value using the given formatter.

impl Hash for Note

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 Note

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

impl Eq for Note

impl StructuralPartialEq for Note