Struct Channel

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

Represents the MIDI channel. The minimum value is 0, the maximum value is 15. This type will clamp values to the valid range.

Implementations

impl Channel

pub const fn new(value: u8) -> Self

Silently clamps the value if it is out of range. See Self::set.

pub fn get(&self) -> u8

Returns the inner value.

pub fn set(&mut self, value: u8) -> bool

Clamps and sets. Returns true if value was in range. Returns false if value was out-of-range. That is, given a valid range of 1..=5, then set(0) will set the value to 1 and return false. set(4) will set the value to 4 and return true.

Trait Implementations

impl Clone for Channel

fn clone(&self) -> Channel

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Channel

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

Formats the value using the given formatter.

impl Default for Channel

fn default() -> Self

Returns the “default value” for a type.

impl Display for Channel

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

Formats the value using the given formatter.

impl From<Channel> for u8

fn from(value: Channel) -> u8

Converts to this type from the input type.

impl From<u8> for Channel

fn from(value: u8) -> Self

Converts to this type from the input type.

impl Hash for Channel

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 Channel

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

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

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

impl Eq for Channel

impl StructuralPartialEq for Channel