AUDIO
Source snapshot · 12 October 2026

API reference / ravet_foundation::UmpPacket

ravet_foundation

Struct UmpPacket 

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

One complete Universal MIDI Packet, retaining every bit including reserved data.

This validates framing only, not message semantics or negotiated protocol. Words are numeric values; transport byte order must be selected explicitly.

Implementations§

§

impl UmpPacket

pub const fn word_count(first: u32) -> usize

Required word count for a first word, including reserved message types.

pub fn from_words(words: &[u32]) -> Result<Self, UmpError>

Copies exactly one complete packet. No allocation or partial acceptance.

pub fn from_be_bytes(bytes: &[u8]) -> Result<Self, UmpError>

Reads an explicitly big-endian byte representation of one packet. This is an application serialization choice, not a universal UMP transport.

pub fn write_be_bytes(self, output: &mut [u8]) -> Result<usize, UmpError>

Writes complete big-endian words, preserving destination tails. An undersized destination is unchanged.

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

Complete numeric words in specification order.

pub const fn message_type(self) -> u8

Four-bit message type.

pub const fn group(self) -> Option<u8>

Group for currently defined grouped types; utility, stream and reserved message types return None rather than inventing addressing semantics.

Trait Implementations§

§

impl Clone for UmpPacket

§

fn clone(&self) -> UmpPacket

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

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

Performs copy-assignment from source. Read more
§

impl Copy for UmpPacket

§

impl Debug for UmpPacket

§

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

Formats the value using the given formatter. Read more
§

impl Eq for UmpPacket

§

impl PartialEq for UmpPacket

§

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

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

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

Inequality operator !=. Read more
§

impl StructuralPartialEq for UmpPacket

Auto Trait Implementations§

Blanket Implementations§

§

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

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

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

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

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

§

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

Mutably borrows from an owned value. Read more
§

impl<T> CloneToUninit for T
where T: Clone,

§

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

Performs copy-assignment from self to dest. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

fn into(self) -> U

Calls U::from(self).

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

§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
§

fn to_owned(&self) -> T

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

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

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

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

§

type Error = Infallible

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

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

Performs the conversion.
§

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.
§

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

Performs the conversion.