Struct Midi2Event 

pub struct Midi2Event { /* private fields */ }

A raw MIDI 2.0 event.

While it is possible to use a series of MIDI 2.0 events to send sysex data, it is recommended to use the MidiSysExEvent type instead for efficiency.

Implementations

impl Midi2Event

pub const fn new(time: u32, port_index: u16, data: [u32; 4]) -> Midi2Event

Creates a new raw MIDI 2.0 event from a time stamp, a port_index, and raw MIDI data.

pub const fn data(&self) -> [u32; 4]

The raw MIDI 2.0 data, as 4 u32s.

pub const fn set_data(&mut self, data: [u32; 4])

Sets the raw MIDI 2.0 data, as 4 u32s.

pub const fn with_data(self, data: [u32; 4]) -> Midi2Event

Sets the raw MIDI 2.0 data, as 4 u32s.

pub const fn port_index(&self) -> u16

The index of the port this event applies to.

pub const fn set_port_index(&mut self, port_index: u16)

Sets the index of the port this event applies to.

pub const fn with_port_index(self, port_index: u16) -> Midi2Event

Sets the index of the port this event applies to.

pub const fn as_raw(&self) -> &clap_event_midi2

Returns a shared reference to the underlying raw, C-FFI compatible event struct.

pub const unsafe fn as_raw_mut(&mut self) -> &mut clap_event_midi2

Returns an exclusive, mutable reference to the raw, C-FFI compatible event struct.

Safety

This method allows mutating the event header’s fields, most notably type_, size and space_id.

Modifying those fields may trigger Undefined Behavior, as it can make other readers of this event treat it as a type or size that it is actually not.

pub const fn from_raw(raw: &clap_event_midi2) -> Midi2Event

Creates a new event of this type from a reference to a raw, C-FFI compatible event struct.

Panics

This method will panic if the given event struct’s header doesn’t actually match the expected event type.

pub const fn from_raw_ref(raw: &clap_event_midi2) -> &Midi2Event

Creates a reference to an event of this type from a reference to a raw, C-FFI compatible event struct.

Panics

This method will panic if the given event struct’s header doesn’t actually match the expected event type.

pub const fn from_raw_mut(raw: &mut clap_event_midi2) -> &mut Midi2Event

Creates a mutable reference to a note event of this type from a reference to a raw, C-FFI compatible event struct.

Panics

This method will panic if the given event struct’s header doesn’t actually match the expected note event type.

Trait Implementations

impl AsRef<UnknownEvent> for Midi2Event

fn as_ref(&self) -> &UnknownEvent

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Midi2Event

fn clone(&self) -> Midi2Event

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Midi2Event

impl Debug for Midi2Event

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

Formats the value using the given formatter.

impl Eq for Midi2Event

impl Event for Midi2Event

const TYPE_ID: u16 = CLAP_EVENT_MIDI2

The raw event type identifier for this event type.

type EventSpace<'a> = CoreEventSpace<'a>

The event space this event type is a part of.

fn flags(&self) -> EventFlags

Returns the EventFlags of this event.

fn set_flags(&mut self, flags: EventFlags)

Sets the EventFlags of this event.

fn with_flags(self, flags: EventFlags) -> Self

Builds an event with the given EventFlags, and returns it.

fn time(&self) -> u32

Returns the time stamp of this event, in samples.

fn set_time(&mut self, time: u32)

Sets the time stamp of this event, in samples.

fn with_time(self, time: u32) -> Self

Builds an event with the given time stamp, and returns it.

fn header(&self) -> &EventHeader<Self>

Returns a shared, immutable reference to this event’s header.

fn header_mut(&mut self) -> &mut EventHeader<Self>

Returns an exclusive, mutable reference to this event’s header.

fn as_unknown(&self) -> &UnknownEvent

Returns this event as a type-erased UnknownEvent.

fn raw_header(&self) -> &clap_event_header

Returns a shared, immutable reference to the raw, C-FFI compatible representation of this header’s event.

unsafe fn raw_header_mut(&mut self) -> &mut clap_event_header

Returns an exclusive, mutable reference to the raw, C-FFI compatible representation of this header’s event.

impl PartialEq for Midi2Event

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

Equality operator ==.

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

Inequality operator !=.