Enum helgoboss_midi::StructuredShortMessage

pub enum StructuredShortMessage {
    NoteOff {
        channel: Channel,
        key_number: KeyNumber,
        velocity: U7,
    },
    NoteOn {
        channel: Channel,
        key_number: KeyNumber,
        velocity: U7,
    },
    PolyphonicKeyPressure {
        channel: Channel,
        key_number: KeyNumber,
        pressure_amount: U7,
    },
    ControlChange {
        channel: Channel,
        controller_number: ControllerNumber,
        control_value: U7,
    },
    ProgramChange {
        channel: Channel,
        program_number: U7,
    },
    ChannelPressure {
        channel: Channel,
        pressure_amount: U7,
    },
    PitchBendChange {
        channel: Channel,
        pitch_bend_value: U14,
    },
    SystemExclusiveStart,
    TimeCodeQuarterFrame(TimeCodeQuarterFrame),
    SongPositionPointer {
        position: U14,
    },
    SongSelect {
        song_number: U7,
    },
    TuneRequest,
    SystemExclusiveEnd,
    TimingClock,
    Start,
    Continue,
    Stop,
    ActiveSensing,
    SystemReset,
    SystemCommonUndefined1,
    SystemCommonUndefined2,
    SystemRealTimeUndefined1,
    SystemRealTimeUndefined2,
}

A short message implemented as an enum where each variant contains exactly the data which is relevant for the particular message type.

This enum is primarily intended for read-only usage via pattern matching. For that reason each variant is a struct-like enum, which is ideal for pattern matching while it is less ideal for reuse (the data contained in the variant can’t be passed around in one piece).

The enum’s size in memory is currently 4 bytes.

Example

use helgoboss_midi::{
    controller_numbers, Channel, RawShortMessage, ShortMessage, ShortMessageFactory,
    StructuredShortMessage, U7,
};

let msg = RawShortMessage::control_change(
    Channel::new(5),
    controller_numbers::DAMPER_PEDAL_ON_OFF,
    U7::new(100),
);
let structured_msg = msg.to_structured();
match structured_msg {
    StructuredShortMessage::ControlChange {
        channel,
        controller_number,
        control_value,
    } => {
        assert_eq!(channel.get(), 5);
        assert_eq!(controller_number.get(), 64);
        assert_eq!(control_value.get(), 100);
    }
    _ => panic!("wrong type"),
};
assert_eq!(structured_msg.channel(), Some(Channel::new(5)));
assert_eq!(core::mem::size_of_val(&structured_msg), 4);

Variants

NoteOff

Fields

channel: Channel

key_number: KeyNumber

velocity: U7

NoteOn

Fields

channel: Channel

key_number: KeyNumber

velocity: U7

PolyphonicKeyPressure

Fields

channel: Channel

key_number: KeyNumber

pressure_amount: U7

ControlChange

Fields

channel: Channel

controller_number: ControllerNumber

control_value: U7

ProgramChange

Fields

channel: Channel

program_number: U7

ChannelPressure

Fields

channel: Channel

pressure_amount: U7

PitchBendChange

Fields

channel: Channel

pitch_bend_value: U14

SystemExclusiveStart

TimeCodeQuarterFrame(TimeCodeQuarterFrame)

SongPositionPointer

Fields

position: U14

SongSelect

Fields

song_number: U7

TuneRequest

SystemExclusiveEnd

TimingClock

Start

Continue

Stop

ActiveSensing

SystemReset

SystemCommonUndefined1

SystemCommonUndefined2

SystemRealTimeUndefined1

SystemRealTimeUndefined2

Trait Implementations

impl Clone for StructuredShortMessage

fn clone(&self) -> StructuredShortMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StructuredShortMessage

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

Formats the value using the given formatter.

impl Hash for StructuredShortMessage

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 StructuredShortMessage

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<StructuredShortMessage> for StructuredShortMessage

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

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

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

This method tests for !=.

impl PartialOrd<StructuredShortMessage> for StructuredShortMessage

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

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

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

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

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

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

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

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

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

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

impl ShortMessage for StructuredShortMessage

fn status_byte(&self) -> u8

Returns the status byte.

fn data_byte_1(&self) -> U7

Returns the first data byte.

fn data_byte_2(&self) -> U7

Returns the second data byte.

fn to_structured(&self) -> StructuredShortMessage

Converts this message to a StructuredShortMessage, which is ideal for matching.

fn to_bytes(&self) -> (u8, U7, U7)

Returns the status byte and the two data bytes as a tuple.

fn to_other<O: ShortMessageFactory>(&self) -> O

Converts this message to a short message of another type.

fn type(&self) -> ShortMessageType

Returns the type of this message.

fn super_type(&self) -> MessageSuperType

Returns the super type of this message.

fn main_category(&self) -> MessageMainCategory

Returns the main category of this message.

fn is_note_on(&self) -> bool

Returns whether this message is a note-on in a practical sense. That means, it also returns false if the message type is NoteOn but the velocity is zero.

fn is_note_off(&self) -> bool

Returns whether this message is a note-off in a practical sense. That means, it also returns true if the message type is NoteOn but the velocity is zero.

fn is_note(&self) -> bool

Returns whether this message is a note-on or note-off.

fn channel(&self) -> Option<Channel>

Returns the channel of this message if applicable.

fn key_number(&self) -> Option<KeyNumber>

Returns the key number of this message if applicable.

fn velocity(&self) -> Option<U7>

Returns the velocity of this message if applicable.

fn controller_number(&self) -> Option<ControllerNumber>

Returns the controller number of this message if applicable.

fn control_value(&self) -> Option<U7>

Returns the control value of this message if applicable.

fn program_number(&self) -> Option<U7>

Returns the program number of this message if applicable.

fn pressure_amount(&self) -> Option<U7>

Returns the pressure amount of this message if applicable.

fn pitch_bend_value(&self) -> Option<U14>

Returns the pitch bend value of this message if applicable.

impl ShortMessageFactory for StructuredShortMessage

unsafe fn from_bytes_unchecked(
    (status_byte, data_byte_1, data_byte_2): (u8, U7, U7)
) -> Self

Creates a MIDI message from the given bytes without checking the status byte. The tuple consists of the status byte, data byte 1 and data byte 2 in exactly this order.

fn from_bytes(bytes: (u8, U7, U7)) -> Result<Self, FromBytesError>

Creates a MIDI message from the given bytes. The tuple consists of the status byte, data byte 1 and data byte 2 in exactly this order.

fn from_other(msg: &impl ShortMessage) -> Self

Creates this message from a MIDI message of another type.

fn channel_message(
    type: ShortMessageType,
    channel: Channel,
    data_1: U7,
    data_2: U7
) -> Self

Creates a Channel message.

fn system_common_message(type: ShortMessageType, data_1: U7, data_2: U7) -> Self

Creates a System Common message.

fn system_real_time_message(type: ShortMessageType) -> Self

Creates a System Real Time message.

fn note_on(channel: Channel, key_number: KeyNumber, velocity: U7) -> Self

Creates a Note On message.

fn note_off(channel: Channel, key_number: KeyNumber, velocity: U7) -> Self

Creates a Note Off message.

fn control_change(
    channel: Channel,
    controller_number: ControllerNumber,
    control_value: U7
) -> Self

Creates a Control Change message.

fn program_change(channel: Channel, program_number: U7) -> Self

Creates a Program Change message.

fn polyphonic_key_pressure(
    channel: Channel,
    key_number: KeyNumber,
    pressure_amount: U7
) -> Self

Creates a Polyphonic Key Pressure message.

fn channel_pressure(channel: Channel, pressure_amount: U7) -> Self

Creates a Channel Pressure message.

fn pitch_bend_change(channel: Channel, pitch_bend_value: U14) -> Self

Creates a Pitch Bend Change message.

fn system_exclusive_start() -> Self

Creates the start of a System Exclusive message.

fn time_code_quarter_frame(frame: TimeCodeQuarterFrame) -> Self

Creates a MIDI Time Code Quarter Frame message.

fn song_position_pointer(position: U14) -> Self

Creates a Song Position Pointer message.

fn song_select(song_number: U7) -> Self

Creates a Song Select message.

fn tune_request() -> Self

Creates a Tune Request message.

fn system_exclusive_end() -> Self

Creates the end of a System Exclusive message.

fn timing_clock() -> Self

Creates a Timing Clock message.

fn start() -> Self

Creates a Start message.

fn continue() -> Self

Creates a Continue message.

fn stop() -> Self

Creates a Stop message.

fn active_sensing() -> Self

Creates an Active Sensing message.

fn system_reset() -> Self

Creates a System Reset message.

impl Copy for StructuredShortMessage

impl Eq for StructuredShortMessage

impl StructuralEq for StructuredShortMessage

impl StructuralPartialEq for StructuredShortMessage