Struct Header 

pub struct Header {
    pub packet_type: PacketType,
    pub sequence_number: u8,
    pub pixel_config: PixelConfig,
    pub id: ID,
    pub offset: u32,
    pub length: u16,
    pub time_code: TimeCode,
}

DDP packet header containing metadata and control flags.

The header is 10 bytes (or 14 with timecode) and contains all the information needed to interpret the packet payload.

Examples

use ddp_rs::protocol::{Header, PacketType, PixelConfig, ID, timecode::TimeCode};

let header = Header {
    packet_type: PacketType::default(),
    sequence_number: 1,
    pixel_config: PixelConfig::default(),
    id: ID::Default,
    offset: 0,
    length: 9,
    time_code: TimeCode(None),
};

// Convert to bytes for transmission
let bytes: [u8; 10] = header.into();

Fields

packet_type: PacketType

Packet type flags (version, timecode, storage, reply, query, push)

sequence_number: u8

Sequence number (1-15, wraps around to 1)

pixel_config: PixelConfig

Pixel format configuration (RGB, RGBW, etc.)

id: ID

Protocol message ID

offset: u32

Byte offset into the display buffer

length: u16

Length of data in this packet (in bytes)

time_code: TimeCode

Optional timecode for synchronization (if timecode flag is set)

Implementations

impl Header

pub fn write_into(&self, buf: &mut [u8]) -> usize

Serializes this header into the start of buf, returning the number of bytes written (10, or 14 when a timecode is present).

This is the allocation-free, no_std-friendly equivalent of the Into<[u8; 10]> / Into<[u8; 14]> conversions — useful when writing a packet directly into a reusable transmit buffer.

Panics

Panics if buf is shorter than the required header length.

Examples

use ddp_rs::protocol::Header;

let header = Header::default();
let mut buf = [0u8; 10];
let n = header.write_into(&mut buf);
assert_eq!(n, 10);

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Header

impl Debug for Header

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

Formats the value using the given formatter.

impl Default for Header

fn default() -> Header

Returns the “default value” for a type.

impl Eq for Header

impl<'a> From<&'a [u8]> for Header

fn from(bytes: &'a [u8]) -> Self

Converts to this type from the input type.

impl From<Header> for [u8; 10]

fn from(header: Header) -> Self

Converts to this type from the input type.

impl From<Header> for [u8; 14]

fn from(header: Header) -> Self

Converts to this type from the input type.

impl Hash for Header

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Header

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Header