Struct helgoboss_midi::KeyNumber

pub struct KeyNumber(_);

A key number (0 - 127), e.g. of a MIDI Note On message.

Methods

impl KeyNumber

pub const MIN: KeyNumber

The smallest value that can be represented by this type.

pub const MAX: KeyNumber

The largest value that can be represented by this type.

pub fn new(value: u8) -> KeyNumber

Creates a KeyNumber.

Panics

This function panics if value is greater than 127.

pub const unsafe fn new_unchecked(value: u8) -> KeyNumber

Creates a KeyNumber without checking value.

Safety

value must not be greater than 127.

pub const fn get(self) -> u8

Returns the value as a primitive type.

Trait Implementations

impl Clone for KeyNumber

fn clone(&self) -> KeyNumber

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for KeyNumber

impl Debug for KeyNumber

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

Formats the value using the given formatter.

impl Default for KeyNumber

fn default() -> KeyNumber

Returns the "default value" for a type.

impl Display for KeyNumber

fn fmt(&self, _derive_more_display_formatter: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Eq for KeyNumber

impl From<KeyNumber> for U7

fn from(value: KeyNumber) -> Self

Performs the conversion.

impl From<KeyNumber> for u8

fn from(value: KeyNumber) -> Self

Performs the conversion.

impl From<KeyNumber> for i128

fn from(value: KeyNumber) -> Self

Performs the conversion.

impl From<KeyNumber> for usize

fn from(value: KeyNumber) -> Self

Performs the conversion.

impl From<KeyNumber> for isize

fn from(value: KeyNumber) -> Self

Performs the conversion.

impl From<KeyNumber> for i8

fn from(value: KeyNumber) -> Self

Performs the conversion.

impl From<KeyNumber> for u16

fn from(value: KeyNumber) -> Self

Performs the conversion.

impl From<KeyNumber> for i16

fn from(value: KeyNumber) -> Self

Performs the conversion.

impl From<KeyNumber> for u32

fn from(value: KeyNumber) -> Self

Performs the conversion.

impl From<KeyNumber> for i32

fn from(value: KeyNumber) -> Self

Performs the conversion.

impl From<KeyNumber> for u64

fn from(value: KeyNumber) -> Self

Performs the conversion.

impl From<KeyNumber> for i64

fn from(value: KeyNumber) -> Self

Performs the conversion.

impl From<KeyNumber> for u128

fn from(value: KeyNumber) -> Self

Performs the conversion.

impl From<U7> for KeyNumber

fn from(value: U7) -> Self

Performs the conversion.

impl Hash for KeyNumber

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, 

Feeds a slice of this type into the given [Hasher].

impl Ord for KeyNumber

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<KeyNumber> for KeyNumber

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<KeyNumber> for KeyNumber

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralEq for KeyNumber

impl StructuralPartialEq for KeyNumber

impl TryFrom<i128> for KeyNumber

type Error = TryFromGreaterError

The type returned in the event of a conversion error.

fn try_from(value: i128) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<i16> for KeyNumber

type Error = TryFromGreaterError

The type returned in the event of a conversion error.

fn try_from(value: i16) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<i32> for KeyNumber

type Error = TryFromGreaterError

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<i64> for KeyNumber

type Error = TryFromGreaterError

The type returned in the event of a conversion error.

fn try_from(value: i64) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<isize> for KeyNumber

type Error = TryFromGreaterError

The type returned in the event of a conversion error.

fn try_from(value: isize) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u128> for KeyNumber

type Error = TryFromGreaterError

The type returned in the event of a conversion error.

fn try_from(value: u128) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u16> for KeyNumber

type Error = TryFromGreaterError

The type returned in the event of a conversion error.

fn try_from(value: u16) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u32> for KeyNumber

type Error = TryFromGreaterError

The type returned in the event of a conversion error.

fn try_from(value: u32) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u64> for KeyNumber

type Error = TryFromGreaterError

The type returned in the event of a conversion error.

fn try_from(value: u64) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u8> for KeyNumber

type Error = TryFromGreaterError

The type returned in the event of a conversion error.

fn try_from(value: u8) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<usize> for KeyNumber

type Error = TryFromGreaterError

The type returned in the event of a conversion error.

fn try_from(value: usize) -> Result<Self, Self::Error>

Performs the conversion.