Struct helgoboss_midi::RawShortMessage

pub struct RawShortMessage(_);

A short message implemented as a tuple of bytes.

The struct's size in memory is currently 3 bytes.

Example

use helgoboss_midi::{
    Channel, KeyNumber, MessageMainCategory, MessageSuperType, RawShortMessage, ShortMessage,
    ShortMessageFactory, ShortMessageType, U7,
};

let msg = RawShortMessage::note_on(Channel::new(5), KeyNumber::new(64), U7::new(123));
assert_eq!(std::mem::size_of_val(&msg), 3);
assert_eq!(msg.status_byte(), 149);
assert_eq!(msg.data_byte_1().get(), 64);
assert_eq!(msg.data_byte_2().get(), 123);
assert_eq!(msg.r#type(), ShortMessageType::NoteOn);
assert_eq!(msg.super_type(), MessageSuperType::ChannelVoice);
assert_eq!(msg.main_category(), MessageMainCategory::Channel);
assert_eq!(msg.channel(), Some(Channel::new(5)));
assert_eq!(msg.key_number(), Some(KeyNumber::new(64)));
assert_eq!(msg.velocity(), Some(U7::new(123)));
assert_eq!(msg.controller_number(), None);
assert_eq!(msg.control_value(), None);

Trait Implementations

impl Clone for RawShortMessage

fn clone(&self) -> RawShortMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for RawShortMessage

impl Debug for RawShortMessage

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

Formats the value using the given formatter.

impl Eq for RawShortMessage

impl From<RawShortMessage> for (u8, U7, U7)

fn from(original: RawShortMessage) -> (u8, U7, U7)

Performs the conversion.

impl Hash for RawShortMessage

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 PartialEq<RawShortMessage> for RawShortMessage

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

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

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

This method tests for !=.

impl ShortMessage for RawShortMessage

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_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 to_structured(&self) -> StructuredShortMessage

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

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 RawShortMessage

unsafe fn from_bytes_unchecked(bytes: (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(
    r#type: ShortMessageType,
    channel: Channel,
    data_1: U7,
    data_2: U7
) -> Self

Creates a Channel message.

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

Creates a System Common message.

fn system_real_time_message(r#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 StructuralEq for RawShortMessage

impl StructuralPartialEq for RawShortMessage

impl TryFrom<(u8, U7, U7)> for RawShortMessage

type Error = FromBytesError

The type returned in the event of a conversion error.

fn try_from(value: (u8, U7, U7)) -> Result<Self, Self::Error>

Performs the conversion.