Struct Key

pub struct Key(/* private fields */);

Identifies a key for some message.

Keys are interpeted as a 7-bit number.

Each value corresponds to some Note and Octave.

Key 0 is C(-1), and Key 127 is G9.

Example

let key_byte = 63;

let key = Key::from_databyte(key_byte).unwrap(); // 63 is between 0-127

assert_eq!(key.note(), Note::DSharp);
assert_eq!(key.octave(), Octave::new(4))

Implementations

impl Key

pub fn from_databyte<B, E>(rep: B) -> Result<Self, Error>

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

Create a new key.

Checks for correctness (leading 0 bit).

pub fn all() -> Vec<Self>

Create all possible keys (128)

pub const fn new(note: Note, octave: Octave) -> Self

Create a key from a given note and octave

Panics

if you pass in, on Octave::new(9) a Key greater than Key::G.

this is because Key::GSharp-Key::B for octave 9 is not representable in midi.

pub fn note(&self) -> Note

Identifies the note of the key pressed

pub fn is_sharp(&self) -> bool

Returns true if the note of the key is sharp. Same as is_flat

See Note::is_sharp for an example

pub fn is_flat(&self) -> bool

Returns true if the note of the key is flat. Same as is_sharp See Note::is_flat for an example

pub fn octave(&self) -> Octave

Identifies the octave of the key pressed

pub fn byte(&self) -> u8

Returns the underlying byte of the key

Trait Implementations

impl Add<u8> for Key

type Output = Key

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<u8> for Key

fn add_assign(&mut self, rhs: u8)

Performs the += operation.

impl Clone for Key

fn clone(&self) -> Key

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Key

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

Formats the value using the given formatter.

impl Display for Key

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

Formats the value using the given formatter.

impl Hash for Key

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 Ord for Key

fn cmp(&self, other: &Key) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Key

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

fn partial_cmp(&self, other: &Key) -> 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 Sub<u8> for Key

type Output = Key

The resulting type after applying the - operator.

fn sub(self, rhs: u8) -> Self::Output

Performs the - operation.

impl SubAssign<u8> for Key

fn sub_assign(&mut self, rhs: u8)

Performs the -= operation.

impl Copy for Key

impl Eq for Key

impl StructuralPartialEq for Key