pub struct MidiHost { /* private fields */ }
Expand description

Host for MIDI messages, opens all ports & forwards them onto a lock-free queue the audio-thread can pop from.

The host will close all MIDI connections on drop.

Implementations§

source§

impl MidiHost

source

pub fn new(handle: &Handle, capacity: usize) -> Self

Create the host, linked to GC Handle and with queue capacity of messages.

source

pub fn default_with_handle(handle: &Handle) -> Self

Create the host with default 100 capacity

source

pub fn default_with_queue(handle: &Handle, queue: MidiMessageQueue) -> Self

Build a MidiHost with a pre-built queue

source

pub fn messages(&self) -> &MidiMessageQueue

Get a reference to the message queue

source

pub fn start_midi(&mut self) -> Result<(), MidiError>

Start the MIDI connections

source

pub fn virtual_port_name(&self) -> String

For integration testing purposes MidiHost starts a virtual input which it’ll also connect into. This input contains the PID of the host process.

Generating this name dynamically avoids flakiness in integration tests.

Trait Implementations§

source§

impl Default for MidiHost

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl Drop for MidiHost

source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.