Enum midi_msg::MidiMsg

pub enum MidiMsg {
    ChannelVoice {
        channel: Channel,
        msg: ChannelVoiceMsg,
    },
    RunningChannelVoice {
        channel: Channel,
        msg: ChannelVoiceMsg,
    },
    ChannelMode {
        channel: Channel,
        msg: ChannelModeMsg,
    },
    RunningChannelMode {
        channel: Channel,
        msg: ChannelModeMsg,
    },
    SystemCommon {
        msg: SystemCommonMsg,
    },
    SystemRealTime {
        msg: SystemRealTimeMsg,
    },
    SystemExclusive {
        msg: SystemExclusiveMsg,
    },
}

The primary interface of this library. Used to encode MIDI messages.

Variants

ChannelVoice

Fields

channel: Channel

msg: ChannelVoiceMsg

Channel-level messages that act on a voice, such as turning notes on and off.

RunningChannelVoice

Fields

channel: Channel

msg: ChannelVoiceMsg

Like ChannelVoice, but with the first “status” byte of the message omitted. When these “running status” messages are sent, the receiver must treat them as implicitly referring to the previous “status” received.

For instance, if a ChannelVoiceMsg::NoteOn message is received, and then the next message does not contain a status byte, it implicitly refers to a ChannelVoiceMsg::NoteOn.

ChannelMode

Fields

channel: Channel

msg: ChannelModeMsg

Channel-level messages that should alter the mode of the receiver.

RunningChannelMode

Fields

channel: Channel

msg: ChannelModeMsg

Like RunningChannelVoice but for ChannelMode

SystemCommon

Fields

msg: SystemCommonMsg

A fairly limited set of messages, generally for device synchronization.

SystemRealTime

Fields

msg: SystemRealTimeMsg

Another limited set of messages used for device synchronization.

SystemExclusive

Fields

msg: SystemExclusiveMsg

The bulk of the MIDI spec lives here, in “Universal System Exclusive” messages. Also the home of manufacturer-specific messages.

Implementations

impl MidiMsg

pub fn to_midi(&self) -> Vec<u8>

Turn a MidiMsg into a series of bytes.

pub fn from_midi(m: &[u8]) -> Result<(Self, usize), ParseError>

Turn a series of bytes into a MidiMsg.

Ok results return a MidiMsg and the number of bytes consumed from the input.

pub fn from_midi_with_context( m: &[u8], ctx: &mut ReceiverContext ) -> Result<(Self, usize), ParseError>

Turn a series of bytes into a MidiMsg, given a ReceiverContext.

Consecutive messages that relate to each other will be collapsed into one MidiMsg. E.g. a ChannelVoiceMsg::ControlChange where the CC is the MSB and LSB of ControlChange::Volume will turn into a single ControlChange::Volume with both bytes turned into one. Use MidiMsg::from_midi_with_context_no_extensions to disable this behavior.

The ReceiverContext is also used to track the current TimeCode as sent through SystemCommonMsg::TimeCodeQuarterFrame messages, or UniversalRealTimeMsg::TimeCodeFull messages.

Ok results return a MidiMsg and the number of bytes consumed from the input.

pub fn from_midi_with_context_no_extensions( m: &[u8], ctx: &mut ReceiverContext ) -> Result<(Self, usize), ParseError>

Like MidiMsg::from_midi_with_context but does not turn multiple related consecutive messages into one MidiMsg.

pub fn messages_to_midi(msgs: &[Self]) -> Vec<u8>

Turn a set of MidiMsgs into a series of bytes, with fewer allocations than repeatedly concatenating the results of to_midi.

pub fn extend_midi(&self, v: &mut Vec<u8>)

Given a Vec<u8>, append this MidiMsg to it.

Trait Implementations

impl Clone for MidiMsg

fn clone(&self) -> MidiMsg

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MidiMsg

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

Formats the value using the given formatter.

impl From<&MidiMsg> for Vec<u8>

fn from(m: &MidiMsg) -> Vec<u8>

Converts to this type from the input type.

impl PartialEq for MidiMsg

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for MidiMsg