Struct coremidi::EventBuffer

pub struct EventBuffer { /* fields omitted */ }

Implementations

impl EventBuffer

pub fn new(protocol: Protocol) -> Self

Create an empty EventBuffer for a given Protocol without allocating.

pub fn with_capacity(capacity: usize, protocol: Protocol) -> Self

Create an empty EventBuffer of a given capacity for a given Protocol.

pub fn capacity(&self) -> usize

Get underlying buffer capacity in bytes

pub fn with_packet(self, timestamp: Timestamp, data: &[u32]) -> Self

Add a new packet containing the provided timestamp and data. It consumes the instance and returns it modified with the new packet.

See EventBuffer::push for further details.

Example:

use coremidi::{Protocol, Timestamp, EventBuffer};

let buffer = EventBuffer::new(Protocol::Midi20)
    .with_packet(0, &[0x40903c00, 0xffff0000]); // Note On for Middle C

assert_eq!(buffer.len(), 1);
assert_eq!(
    buffer.iter()
        .map(|packet| (packet.timestamp(), packet.data().to_vec()))
        .collect::<Vec<(Timestamp, Vec<u32>)>>(),
    vec![(0, vec![0x40903c00, 0xffff0000])],
)

pub fn push(&mut self, timestamp: Timestamp, data: &[u32]) -> &mut Self

Add a new event containing the provided timestamp and data.

According to the official documentation for CoreMIDI, the timestamp represents the time at which the events are to be played, where zero means “now”. The timestamp applies to the first MIDI word in the packet.

An event must not have a timestamp that is smaller than that of a previous event in the same EventBuffer

Example:

use coremidi::{EventBuffer, Protocol, Timestamp};

let mut buffer = EventBuffer::new(Protocol::Midi20);
buffer.push(0, &[0x40903c00, 0xffff0000]); // Note On for Middle C

assert_eq!(buffer.len(), 1);
assert_eq!(
    buffer.iter()
        .map(|packet| (packet.timestamp(), packet.data().to_vec()))
        .collect::<Vec<(Timestamp, Vec<u32>)>>(),
    vec![(0, vec![0x40903c00, 0xffff0000])],
)

pub fn clear(&mut self)

Clears the buffer, removing all packets. Note that this method has no effect on the allocated capacity of the buffer.

Methods from Deref<Target = EventList>

pub fn protocol(&self) -> Protocol

pub fn is_empty(&self) -> bool

Check if the packet list is empty.

pub fn len(&self) -> usize

Get the number of packets in the list.

pub fn iter(&self) -> EventListIter<'_>

Get an iterator for the packets in the list.

Trait Implementations

impl AsRef<EventList> for EventBuffer

fn as_ref(&self) -> &EventList

Performs the conversion.

impl Clone for EventBuffer

fn clone(&self) -> EventBuffer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Deref for EventBuffer

type Target = EventList

The resulting type after dereferencing.

fn deref(&self) -> &EventList

Dereferences the value.