Struct tune::midi::ChannelMessage

pub struct ChannelMessage { /* fields omitted */ }

A type-safe representation of MIDI messages that aren’t System Common messages.

Implementations

impl ChannelMessage

pub fn from_raw_message(message: &[u8]) -> Option<ChannelMessage>

Parses a MIDI message.

When no valid Channel Voice or Channel Mode message is provided None is returned.

Examples

let message = ChannelMessage::from_raw_message(&[0b1001_1000, 77, 88]).unwrap();
assert_eq!(message.channel(), 8);
assert_eq!(
    message.message_type(),
    ChannelMessageType::NoteOn {
        key: 77,
        velocity: 88
    }
);

let invalid_message = [1, 2, 3];
assert_eq!(ChannelMessage::from_raw_message(&invalid_message), None);

pub fn to_raw_message(&self) -> [u8; 3]

Returns the byte representation of a MIDI message.

Examples

let message = ChannelMessageType::NoteOn {
        key: 77,
        velocity: 88
    }
    .in_channel(7)
    .unwrap();

assert_eq!(message.to_raw_message(), [0b1001_0111, 77, 88]);

pub fn channel(&self) -> u8

Returns the channel of a MIDI message.

Examples

let message = ChannelMessage::from_raw_message(&[0b1001_1000, 77, 88]).unwrap();
assert_eq!(message.channel(), 8);

pub fn message_type(&self) -> ChannelMessageType

Returns the channel-agnostic part of a MIDI message.

Examples

let message = ChannelMessage::from_raw_message(&[0b1001_1000, 77, 88]).unwrap();
assert!(matches!(message.message_type(), ChannelMessageType::NoteOn { .. }));

Trait Implementations

impl Clone for ChannelMessage

fn clone(&self) -> ChannelMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ChannelMessage

impl Debug for ChannelMessage

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

Formats the value using the given formatter.

impl Eq for ChannelMessage

impl PartialEq<ChannelMessage> for ChannelMessage

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

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

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

This method tests for !=.

impl StructuralEq for ChannelMessage

impl StructuralPartialEq for ChannelMessage