Struct FrameDescriptor 

pub struct FrameDescriptor {

    pub v: u16,
    pub camera_id: String,
    pub frame_id: u64,
    pub ts_ns: u64,
    pub ts_sensor_ns: Option<u64>,
    pub exposure_ns: Option<u32>,
    pub trigger_seq: Option<u64>,
    pub timebase: u8,
    pub width: u32,
    pub height: u32,
    pub format: FrameFormat,
    pub shm_name: String,
    pub slot: u32,
    pub seq: u64,
    pub byte_len: u32,
}

The small message published on vision.frame. It names the ring slot a consumer should read and carries the seq that the per-slot seqlock must still hold for the read to be valid.

Fields

v: u16

Wire version, stamped on every descriptor and checked on decode. A consumer that sees a version it does not speak rejects the frame instead of mis-parsing it. Deliberately carries no serde default: a payload missing this field fails to decode.

camera_id: String

Source camera id (a UVC/CSI device the engine owns, or the FPV camera tapped from the video pipeline). Lets a consumer filter by camera.

frame_id: u64

Monotonic frame counter for this camera, starting at 1.

ts_ns: u64

Host CLOCK_MONOTONIC ns: exposure midpoint when known, else arrival.

ts_sensor_ns: Option<u64>

Source-clock timestamp in ns, interpreted per timebase.

exposure_ns: Option<u32>

Exposure duration in ns, when the source reports it.

trigger_seq: Option<u64>

Hardware trigger sequence that produced this frame, when known.

timebase: u8

Clock domain of ts_sensor_ns (TIMEBASE_*).

width: u32

height: u32

format: FrameFormat

shm_name: String

/dev/shm name of the ring this frame lives in (one ring per camera).

slot: u32

Slot index within the ring holding this frame’s pixels.

seq: u64

Ring sequence stamped on the slot. A consumer re-checks this against the slot’s seqlock after copying; a mismatch means the writer recycled the slot mid-read and the frame must be dropped.

byte_len: u32

Length of the valid pixel bytes in the slot (format.frame_bytes).

Implementations

impl FrameDescriptor

pub fn to_msgpack(&self) -> Result<Vec<u8>, Error>

Encode as a msgpack map with named keys (matches the Python reader).

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

Decode from a msgpack map, rejecting a descriptor whose wire version this build does not speak. A missing v field fails the msgpack decode; a present-but-unknown v returns DescriptorError::Version.

Trait Implementations

impl Clone for FrameDescriptor

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FrameDescriptor

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FrameDescriptor

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for FrameDescriptor

impl PartialEq for FrameDescriptor

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for FrameDescriptor

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FrameDescriptor