Struct FrameHeader 

pub struct FrameHeader {
    pub pixel_format: PixelFormat,
    pub width: u32,
    pub height: u32,
    pub seq: u32,
}

16-byte binary frame header prepended to every image payload.

See module-level documentation for the byte layout and format discriminant table.

Fields

pixel_format: PixelFormat

Pixel format of the following pixel data.

width: u32

Image width in pixels.

height: u32

Image height in pixels.

seq: u32

Monotonically increasing frame sequence number (wraps at u32::MAX).

Implementations

impl FrameHeader

pub fn encode(&self) -> Vec<u8>

Encode this header into a 16-byte Vec<u8>.

pub fn decode(buf: &[u8]) -> Result<(FrameHeader, &[u8]), FrameHeaderError>

Decode a header from the front of buf.

On success returns (header, pixel_data_slice) where pixel_data_slice is the remaining bytes after the 16-byte header.

Trait Implementations

impl Clone for FrameHeader

fn clone(&self) -> FrameHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FrameHeader

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

Formats the value using the given formatter.

impl PartialEq for FrameHeader

fn eq(&self, other: &FrameHeader) -> 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 Eq for FrameHeader

impl StructuralPartialEq for FrameHeader