Struct MidiInput

pub struct MidiInput(/* private fields */);

Pointer to a MIDI input device.

Implementations

impl MidiInput

pub fn get_read_buf(&self) -> MidiEventList<'_>

Returns the list of MIDI events which are currently in the buffer.

This must only be called in the real-time audio thread! See get_midi_input().

Design

In the past this function was unsafe and expected a closure which let the consumer do something with the event list. All of that is not necessary anymore since we ensure in get_midi_input() that we only ever publish valid MidiInput instances, and those only by a very short-lived reference that’s not possible to cache anywhere. That makes it possible to bind the lifetime of the event list to the one of the MidiInput and everything is fine!

Returning an owned event list would be wasteful because we would need to copy all events first. That would be especially bad because this code is supposed to run in the audio thread and therefore has real-time requirements.

Trait Implementations

impl Debug for MidiInput

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

Formats the value using the given formatter.

impl Hash for MidiInput

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for MidiInput

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for MidiInput

impl StructuralPartialEq for MidiInput