Enum augmented_midi::MIDIMessage

pub enum MIDIMessage<Buffer: Borrow<[u8]>> {
    NoteOn(MIDIMessageNote),
    NoteOff(MIDIMessageNote),
    PolyphonicKeyPressure {
        channel: u8,
        note: u8,
        pressure: u8,
    },
    ControlChange {
        channel: u8,
        controller_number: u8,
        value: u8,
    },
    ProgramChange {
        channel: u8,
        program_number: u8,
    },
    ChannelPressure {
        channel: u8,
        pressure: u8,
    },
    PitchWheelChange {
        channel: u8,
        value: u16,
    },
    SysExMessage(MIDISysExEvent<Buffer>),
    SongPositionPointer {
        beats: u16,
    },
    SongSelect {
        song: u8,
    },
    TuneRequest,
    TimingClock,
    Start,
    Continue,
    Stop,
    ActiveSensing,
    Reset,
    Other {
        status: u8,
    },
}

Represents a MIDI message

Variants

NoteOn(MIDIMessageNote)

NoteOff(MIDIMessageNote)

PolyphonicKeyPressure

Fields

channel: u8

note: u8

pressure: u8

ControlChange

Fields

channel: u8

controller_number: u8

value: u8

ProgramChange

Fields

channel: u8

program_number: u8

ChannelPressure

Fields

channel: u8

pressure: u8

PitchWheelChange

Fields

channel: u8

value: u16

SysExMessage(MIDISysExEvent<Buffer>)

SongPositionPointer

Fields

beats: u16

SongSelect

Fields

song: u8

TuneRequest

TimingClock

Start

Continue

Stop

ActiveSensing

Reset

Other

Fields

status: u8

Implementations

impl<Buffer: Borrow<[u8]>> MIDIMessage<Buffer>

pub fn note_on(channel: u8, note: u8, velocity: u8) -> Self

Helper to construct MIDIMessage::NoteOn

pub fn note_off(channel: u8, note: u8, velocity: u8) -> Self

Helper to construct MIDIMessage::NoteOff

pub fn control_change(channel: u8, controller_number: u8, value: u8) -> Self

pub fn size_hint(&self) -> usize

This returns the size in bytes of this message when serialised into MIDI.

Trait Implementations

impl<Buffer: Clone + Borrow<[u8]>> Clone for MIDIMessage<Buffer>

fn clone(&self) -> MIDIMessage<Buffer>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Buffer: Debug + Borrow<[u8]>> Debug for MIDIMessage<Buffer>

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

Formats the value using the given formatter.

impl<B: Borrow<[u8]>> From<MIDIMessage<B>> for Vec<u8>

fn from(msg: MIDIMessage<B>) -> Vec<u8>

Converts to this type from the input type.

impl<Buffer: Ord + Borrow<[u8]>> Ord for MIDIMessage<Buffer>

fn cmp(&self, other: &MIDIMessage<Buffer>) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<Buffer: PartialEq + Borrow<[u8]>> PartialEq for MIDIMessage<Buffer>

fn eq(&self, other: &MIDIMessage<Buffer>) -> 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<Buffer: PartialOrd + Borrow<[u8]>> PartialOrd for MIDIMessage<Buffer>

fn partial_cmp(&self, other: &MIDIMessage<Buffer>) -> 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<'a> TryFrom<&'a [u8]> for MIDIMessage<&'a [u8]>

type Error = Err<Error<&'a [u8]>>

The type returned in the event of a conversion error.

fn try_from(value: &'a [u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl<Buffer: Eq + Borrow<[u8]>> Eq for MIDIMessage<Buffer>

impl<Buffer: Borrow<[u8]>> StructuralEq for MIDIMessage<Buffer>

impl<Buffer: Borrow<[u8]>> StructuralPartialEq for MIDIMessage<Buffer>