Skip to main content

PacketRef

Struct PacketRef 

Source
pub struct PacketRef<'a> {
    pub header: Header,
    pub data: &'a [u8],
}
Expand description

A borrowed, zero-copy view of a received DDP packet.

This is the allocation-free receive path: it parses the header and borrows the payload directly from the input buffer, so it works on bare-metal no_std targets with no allocator. For an owned packet (and JSON message parsing), use Packet (requires the std feature).

§Examples

use ddp_rs::packet::PacketRef;

let bytes = [
    0x41, 0x01, 0x0D, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03,
    0xFF, 0x00, 0x00, // 1 RGB pixel: red
];
let packet = PacketRef::from_bytes(&bytes).unwrap();

assert_eq!(packet.header.sequence_number, 1);
assert_eq!(packet.data, &[0xFF, 0x00, 0x00]);

Fields§

§header: Header

The parsed packet header with metadata.

§data: &'a [u8]

The packet payload, borrowed from the input buffer.

Implementations§

Source§

impl<'a> PacketRef<'a>

Source

pub fn from_bytes(bytes: &'a [u8]) -> Option<Self>

Parses a DDP packet, borrowing the payload from bytes.

Handles both 10-byte and 14-byte (timecode) headers. Returns None if bytes is too short to contain a complete header.

Trait Implementations§

Source§

impl<'a> Clone for PacketRef<'a>

Source§

fn clone(&self) -> PacketRef<'a>

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<'a> Copy for PacketRef<'a>

Source§

impl<'a> Debug for PacketRef<'a>

Source§

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

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

impl<'a> Eq for PacketRef<'a>

Source§

impl<'a> PartialEq for PacketRef<'a>

Source§

fn eq(&self, other: &PacketRef<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<'a> StructuralPartialEq for PacketRef<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for PacketRef<'a>

§

impl<'a> RefUnwindSafe for PacketRef<'a>

§

impl<'a> Send for PacketRef<'a>

§

impl<'a> Sync for PacketRef<'a>

§

impl<'a> Unpin for PacketRef<'a>

§

impl<'a> UnsafeUnpin for PacketRef<'a>

§

impl<'a> UnwindSafe for PacketRef<'a>

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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.