Struct MidiPacket 

pub struct MidiPacket { /* private fields */ }

Packet containing the encoded event.

Implementations

impl MidiPacket

pub const fn new(bytes: [u8; 4]) -> Self

Creates a new packet from bytes.

pub const fn cable_number(&self) -> u8

Returns the cable number.

pub const fn cin(&self) -> u8

Returns the Code Index Number from the packet header.

pub fn event(&self) -> &[u8]

Returns the event bytes, or an empty slice when the packet uses a reserved CIN.

pub const fn event_len(&self) -> usize

Returns the event length, 0 when the packet uses a reserved CIN.

pub fn decode(&self) -> (u8, &[u8])

Returns a tuple of (cable_no, event).

pub const fn as_bytes(&self) -> &[u8; 4]

Returns a reference to the packet bytes.

pub const fn to_bytes(&self) -> [u8; 4]

Returns the packet bytes as owned array.

pub fn try_encode( cable_number: u8, event: &[u8], ) -> Result<(Self, usize), MidiPacketError>

Tries to create a packet from an event with relaxed length checking. The event slice can be longer than expected, additional bytes are ignored. The expected (and used) event length is returned in the result tuple as second member.

pub fn try_encode_exact( cable_number: u8, event: &[u8], ) -> Result<Self, MidiPacketError>

Tries to create a packet from an event with length checking. Returns an error if the event length does not match the expected length.

pub fn is_sysex(&self) -> bool

Checks if the event is part of a SysEx message.

pub fn is_sysex_start(&self) -> bool

Checks if the event is the start of a SysEx message.

pub fn is_sysex_end(&self) -> bool

Checks if the event is the end of a SysEx message.

Trait Implementations

impl Clone for MidiPacket

fn clone(&self) -> MidiPacket

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MidiPacket

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

Formats the value using the given formatter.

impl Eq for MidiPacket

impl Format for MidiPacket

where [u8; 4]: Format,

fn format(&self, f: Formatter<'_>)

Writes the defmt representation of self to fmt.

impl From<[u8; 4]> for MidiPacket

fn from(bytes: [u8; 4]) -> Self

Converts to this type from the input type.

impl PartialEq for MidiPacket

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for MidiPacket

impl TryFrom<&[u8]> for MidiPacket

type Error = MidiPacketError

The type returned in the event of a conversion error.

fn try_from(value: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.