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 of NoteOff

channel: Channelkey_number: KeyNumbervelocity: U7

NoteOn

Fields of NoteOn

channel: Channelkey_number: KeyNumbervelocity: U7

PolyphonicKeyPressure

Fields of PolyphonicKeyPressure

channel: Channelkey_number: KeyNumberpressure_amount: U7

ControlChange

Fields of ControlChange

channel: Channelcontroller_number: ControllerNumbercontrol_value: U7

ProgramChange

Fields of ProgramChange

channel: Channelprogram_number: U7

ChannelPressure

Fields of ChannelPressure

channel: Channelpressure_amount: U7

PitchBendChange

Fields of PitchBendChange

channel: Channelpitch_bend_value: U14

SystemExclusiveStart

TimeCodeQuarterFrame(TimeCodeQuarterFrame)

SongPositionPointer

Fields of SongPositionPointer

position: U14

SongSelect

Fields of SongSelect

song_number: U7

TuneRequest

SystemExclusiveEnd

TimingClock

Start

Continue

Stop

ActiveSensing

SystemReset

SystemCommonUndefined1

SystemCommonUndefined2

SystemRealTimeUndefined1

SystemRealTimeUndefined2

Trait Implementations

impl Clone for StructuredShortMessage

pub fn clone(&self) -> StructuredShortMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for StructuredShortMessage

impl Debug for StructuredShortMessage

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

Formats the value using the given formatter.

impl Eq for StructuredShortMessage

impl Hash for StructuredShortMessage

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

Feeds this value into the given Hasher.

pub 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

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<StructuredShortMessage> for StructuredShortMessage

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

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

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

This method tests for !=.

impl PartialOrd<StructuredShortMessage> for StructuredShortMessage

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

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

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

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

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

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

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

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

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

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

impl ShortMessage for StructuredShortMessage

pub fn status_byte(&self) -> u8

Returns the status byte.

pub fn data_byte_1(&self) -> U7

Returns the first data byte.

pub fn data_byte_2(&self) -> U7

Returns the second data byte.

pub fn to_structured(&self) -> StructuredShortMessage

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

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

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

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

Converts this message to a short message of another type.

pub fn type(&self) -> ShortMessageType

Returns the type of this message.

pub fn super_type(&self) -> MessageSuperType

Returns the super type of this message.

pub fn main_category(&self) -> MessageMainCategory

Returns the main category of this message.

pub 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.

pub 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.

pub fn is_note(&self) -> bool

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

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

Returns the channel of this message if applicable.

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

Returns the key number of this message if applicable.

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

Returns the velocity of this message if applicable.

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

Returns the controller number of this message if applicable.

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

Returns the control value of this message if applicable.

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

Returns the program number of this message if applicable.

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

Returns the pressure amount of this message if applicable.

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

Returns the pitch bend value of this message if applicable.

impl ShortMessageFactory for StructuredShortMessage

pub 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.

pub 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.

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

Creates this message from a MIDI message of another type.

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

Creates a Channel message.

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

Creates a System Common message.

pub fn system_real_time_message(r#type: ShortMessageType) -> Self

Creates a System Real Time message.

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

Creates a Note On message.

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

Creates a Note Off message.

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

Creates a Control Change message.

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

Creates a Program Change message.

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

Creates a Polyphonic Key Pressure message.

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

Creates a Channel Pressure message.

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

Creates a Pitch Bend Change message.

pub fn system_exclusive_start() -> Self

Creates the start of a System Exclusive message.

pub fn time_code_quarter_frame(frame: TimeCodeQuarterFrame) -> Self

Creates a MIDI Time Code Quarter Frame message.

pub fn song_position_pointer(position: U14) -> Self

Creates a Song Position Pointer message.

pub fn song_select(song_number: U7) -> Self

Creates a Song Select message.

pub fn tune_request() -> Self

Creates a Tune Request message.

pub fn system_exclusive_end() -> Self

Creates the end of a System Exclusive message.

pub fn timing_clock() -> Self

Creates a Timing Clock message.

pub fn start() -> Self

Creates a Start message.

pub fn continue() -> Self

Creates a Continue message.

pub fn stop() -> Self

Creates a Stop message.

pub fn active_sensing() -> Self

Creates an Active Sensing message.

pub fn system_reset() -> Self

Creates a System Reset message.

impl StructuralEq for StructuredShortMessage

impl StructuralPartialEq for StructuredShortMessage