Skip to main content

ChannelMessage

Enum ChannelMessage 

Source
pub enum ChannelMessage {
    NoteOff {
        key: u8,
        velocity: u8,
    },
    NoteOn {
        key: u8,
        velocity: u8,
    },
    PolyKeyPressure {
        key: u8,
        pressure: u8,
    },
    ControlChange {
        controller: u8,
        value: u8,
    },
    ProgramChange {
        program: u8,
    },
    ChannelPressure {
        pressure: u8,
    },
    PitchBend {
        value: u16,
    },
}
Expand description

A channel voice message, without its channel.

Data bytes are 7-bit: every field except ChannelMessage::PitchBend holds 0..=127, and the decoder never produces anything else. A note-on with velocity zero is reported as it arrived rather than rewritten into a note-off, because the two are distinguishable on the wire and some devices mean the difference.

Variants§

§

NoteOff

Key released.

Fields

§key: u8

Key number, 0..=127.

§velocity: u8

Release velocity, 0..=127.

§

NoteOn

Key pressed.

Fields

§key: u8

Key number, 0..=127.

§velocity: u8

Strike velocity, 0..=127.

§

PolyKeyPressure

Per-key aftertouch.

Fields

§key: u8

Key number, 0..=127.

§pressure: u8

Pressure, 0..=127.

§

ControlChange

Continuous controller.

Fields

§controller: u8

Controller number, 0..=127.

§value: u8

Controller value, 0..=127.

§

ProgramChange

Program change.

Fields

§program: u8

Program number, 0..=127.

§

ChannelPressure

Channel aftertouch.

Fields

§pressure: u8

Pressure, 0..=127.

§

PitchBend

Pitch bend, 14 bits.

Fields

§value: u16

Bend position, 0..=16383, centred on ChannelMessage::BEND_CENTRE.

Implementations§

Source§

impl ChannelMessage

Source

pub const BEND_CENTRE: u16 = 8192

Pitch bend value meaning no bend.

Source

pub const fn status_nibble(self) -> u8

Returns the high nibble of this message’s status byte.

Source

pub const fn data_len_for(status: u8) -> Option<usize>

Returns how many data bytes follow the status byte of status.

Returns None for a byte that is not a channel status byte.

Source

pub const fn encoded_len(self) -> usize

Returns the number of bytes encode_into writes.

Source

pub fn encode_into(self, channel: Channel, out: &mut [u8]) -> Result<usize>

Writes this message to out, status byte first.

Values wider than their field are masked to 7 bits rather than rejected, so a caller that has already range-checked a value pays nothing and one that has not cannot emit a byte that would be read as a status.

§Errors

Returns Error::BufferTooSmall when out is shorter than encoded_len.

Source

pub const fn from_bytes(status: u8, first: u8, second: u8) -> Option<Self>

Builds a message from a status byte and up to two data bytes.

Returns None when status is not a channel status byte.

Trait Implementations§

Source§

impl Clone for ChannelMessage

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for ChannelMessage

Source§

impl Debug for ChannelMessage

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ChannelMessage

Available on crate feature serde only.
Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for ChannelMessage

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for ChannelMessage

Source§

impl Hash for ChannelMessage

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for ChannelMessage

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

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

Restrict a value to a certain interval. Read more
Source§

fn clamp_to<R>(self, range: R) -> Self
where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)
Restrict a value to a certain range. Read more
Source§

impl PartialEq for ChannelMessage

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl PartialOrd for ChannelMessage

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Serialize for ChannelMessage

Available on crate feature serde only.
Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for ChannelMessage

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.