Skip to main content

RingTrackedMidiBuffer

Struct RingTrackedMidiBuffer 

Source
pub struct RingTrackedMidiBuffer { /* private fields */ }
Expand description

A fixed-capacity ring buffer of TrackedMidiEvents usable as a TrackedMidiSource, tracking the highest track index seen.

Implementations§

Source§

impl RingTrackedMidiBuffer

Source

pub fn new(tpq: u32, capacity: usize) -> Result<Self, LiveMidiError>

Creates a tracked buffer at tpq resolution holding up to capacity events.

Fails with LiveMidiError::ZeroCapacity when capacity is zero.

Source

pub fn capacity(&self) -> usize

Returns the buffer’s maximum capacity.

Source

pub fn len(&self) -> usize

Returns the number of buffered events.

Source

pub fn is_empty(&self) -> bool

Returns whether the buffer is empty.

Source

pub fn last_track(&self) -> usize

Returns the track index of the most recently read event.

Source

pub fn dropped_events(&self) -> usize

Returns the running count of events dropped due to overflow.

Source

pub fn clear(&mut self)

Removes all buffered events and resets the track counters.

Source

pub fn snapshot(&self) -> Vec<TrackedMidiEvent>

Returns a copy of the currently buffered tracked events.

Source

pub fn push_tracked_event(&mut self, event: TrackedMidiEvent)

Pushes a tracked event, updating the track count and dropping the oldest event if the buffer is full.

Trait Implementations§

Source§

impl Clone for RingTrackedMidiBuffer

Source§

fn clone(&self) -> RingTrackedMidiBuffer

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RingTrackedMidiBuffer

Source§

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

Formats the value using the given formatter. Read more
Source§

impl MidiSource for RingTrackedMidiBuffer

Source§

type Err = Infallible

Error type returned by next.
Source§

fn tpq(&self) -> u32

Returns the source resolution in ticks per quarter note.
Source§

fn next(&mut self) -> Result<Option<MidiEvent>, Self::Err>

Returns the next event, or None once the stream is exhausted.
Source§

impl TrackedMidiSource for RingTrackedMidiBuffer

Source§

fn last_track(&self) -> usize

Returns the track index of the most recently yielded event.
Source§

fn n_tracks(&self) -> usize

Returns the total number of tracks in the stream.
Source§

fn next_tracked(&mut self) -> Result<Option<TrackedMidiEvent>, Self::Err>

Returns the next event together with its track tag.

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

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>,

Source§

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.