Skip to main content

UmpPacket

Struct UmpPacket 

Source
pub struct UmpPacket {
    pub words: [u32; 4],
    pub word_count: u8,
}
Expand description

A fixed-capacity Universal MIDI Packet (1..=4 valid 32-bit words).

Fields§

§words: [u32; 4]

Packet words, big-endian per the spec; only word_count are valid.

§word_count: u8

Number of valid words (1..=4).

Implementations§

Source§

impl UmpPacket

Source

pub const fn new32(word0: u32) -> Self

A 32-bit (1-word) packet.

Source

pub const fn new64(word0: u32, word1: u32) -> Self

A 64-bit (2-word) packet.

Source

pub const fn new96(word0: u32, word1: u32, word2: u32) -> Self

A 96-bit (3-word) packet.

Source

pub const fn new128(word0: u32, word1: u32, word2: u32, word3: u32) -> Self

A 128-bit (4-word) packet.

Source

pub const fn message_type(self) -> u8

The Message Type (top nibble of word 0), 0x0..=0xF.

Source

pub const fn group(self) -> u8

The Group (second nibble of word 0), 0..=15.

Source

pub fn as_words(&self) -> &[u32]

Valid words as a slice.

Source

pub fn to_be_bytes(self, out: &mut [u8]) -> Result<usize, AudioError>

Write the valid words as big-endian bytes into out; returns bytes written (word_count * 4). Errors AudioError::OutputBufferTooSmall.

Trait Implementations§

Source§

impl Clone for UmpPacket

Source§

fn clone(&self) -> Self

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 Copy for UmpPacket

Source§

impl Debug for UmpPacket

Source§

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

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

impl Eq for UmpPacket

Source§

impl PartialEq for UmpPacket

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for UmpPacket

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.