Struct MIDIIO 

pub struct MIDIIO { /* private fields */ }

MIDI port.

Lock-free MIDI port shape (see LOCKLESS.md Phase 3):

• sources is published RCU-style by control-side connect/disconnect and read on the RT path by process().
• connections is control-side only (routing queries, disconnect, plan compiler); no RT reader exists.
• buffer/finished are accessed under the plan’s single-writer invariant: every port buffer has exactly one writer per cycle, all readers run in later plan nodes, the engine’s pre-cycle writes are serialized by cycle start, and its post-cycle reads by cycle completion. That invariant is what makes the unsafe accessors sound; it is enforced by the render plan’s MIDI edges and checked by RenderPlan::verify().

Implementations

impl MIDIIO

pub fn new() -> Self

pub fn connect(from: &Arc<MIDIIO>, to: &Arc<MIDIIO>)

Connect producer from to consumer to. Updates both sides so to.sources contains from and from.connections contains to. Control-side only; publishes the new sources list RCU-style.

pub fn disconnect(from: &Arc<MIDIIO>, to: &Arc<MIDIIO>) -> Result<(), String>

Disconnect producer from from consumer to. Removes from both sides. Control-side only.

pub fn add_connection(&self, to: &Arc<MIDIIO>)

Control-side only: record to in this port’s connections without touching to.sources (duplicate-safe). Used by folder/child reparenting, where events flow by direct buffer writes ordered by plan edges rather than by source merging.

pub fn connections(&self) -> Vec<Arc<MIDIIO>>

Control-side snapshot of the ports this port feeds. Used by routing queries and the plan compiler; never on the RT path.

pub fn sources(&self) -> Vec<Arc<MIDIIO>>

Control-side snapshot of the ports feeding this port.

pub unsafe fn setup(&self)

Prepare this port for a new processing cycle.

Safety

The caller must be this port’s sole writer for the coming cycle and no reader may be active (single-writer invariant).

pub unsafe fn process(&self)

Merge events from all connected sources into this port’s buffer. Source buffers are left intact so multiple consumers can read them.

Safety

The single-writer invariant must hold for this port (sole writer this cycle), and every source’s producer must have completed earlier in the plan (MIDI edge) or belong to a finished cycle.

pub unsafe fn buffer(&self) -> &[MidiEvent]

Read the port’s event buffer.

Safety

No writer may be active: the buffer’s producer must have completed (plan ordering or cycle boundary).

pub unsafe fn buffer_mut(&self) -> MidiBufferMut<'_>

Write the port’s event buffer.

Returns a guard instead of a bare &mut so the signature is not &self -> &mut T (clippy::mut_from_ref); the guard derefs to Vec<MidiEvent>, so call sites use it like the old field access.

Safety

The caller must be this port’s sole writer this cycle and no reader may be active (single-writer invariant).

pub fn ready(&self) -> bool

Returns true if this port has finished processing this cycle. A port with no sources is considered ready once it has finished producing; a port with sources is ready only when all sources have.

pub fn mark_finished(&self)

Mark this port as finished without processing (used by producers such as track inputs that fill their buffer directly).

Trait Implementations

impl Debug for MIDIIO

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

Formats the value using the given formatter.

impl Default for MIDIIO

fn default() -> MIDIIO

Returns the “default value” for a type.

impl Sync for MIDIIO