Skip to main content

FrameMeta

Struct FrameMeta 

Source
pub struct FrameMeta {
    pub frame_seq: u64,
    pub tile_index: u16,
    pub tile_count: u16,
    pub x: u32,
    pub y: u32,
    pub w: u32,
    pub h: u32,
    pub screen_w: u32,
    pub screen_h: u32,
    pub captured_at_ms: u64,
}
Expand description

Metadata for one tile, carried in NATS headers alongside the raw image payload.

Also Serialize/Deserialize: the same metadata travels as JSON over the agent’s in-session IPC pipe, where there are no NATS headers to put it in. One type describing a tile, two encodings of it depending on which hop it is crossing — the alternative was a near-duplicate struct that would drift the first time a field was added.

Fields§

§frame_seq: u64

Monotonic per-session frame counter. Tiles of the same frame share it, which is what lets a viewer decide whether it is assembling a coherent picture or has started receiving the next one.

§tile_index: u16

Index of this tile within its frame, 0..tile_count.

§tile_count: u16

How many tiles this frame was split into. A viewer that has seen all of them can present the frame; one that is missing some can still paint what arrived — tiles are independent images, so a dropped tile degrades to a stale rectangle rather than a corrupt screen.

§x: u32

Tile origin in desktop pixels.

§y: u32§w: u32

Tile size in pixels.

§h: u32§screen_w: u32

Full desktop size, repeated on every tile.

Redundant by design: a viewer that joins mid-session, or reconnects, can size its canvas from the first tile it happens to receive without waiting for a control round-trip or a full frame.

§screen_h: u32§captured_at_ms: u64

Agent-side capture time, milliseconds since the Unix epoch.

For measuring one-way latency (#1140 risk 2 — whether control across the overlay is usable at all). Clocks are not synchronised between endpoint and backend, so treat the absolute value as untrustworthy; the differences between consecutive frames from one agent are what carry signal.

Implementations§

Source§

impl FrameMeta

Source

pub fn to_headers(&self, encoding: TileEncoding) -> HeaderMap

Write this metadata into a NATS header map, together with the encoding (which lives outside the struct because it describes the payload, not the geometry).

Source

pub fn from_headers( h: &HeaderMap, ) -> Result<(Self, TileEncoding), FrameMetaError>

Parse metadata back out of a NATS header map.

Validates geometry as well as presence: a tile that claims to fall outside its own screen would otherwise reach a viewer’s canvas draw and either throw or silently paint nothing, far from the corrupt header that caused it.

Source

pub fn validate(&self) -> Result<(), FrameMetaError>

Geometry sanity. Split out so a sender can check before publishing rather than leaving it to the receiver to reject.

Trait Implementations§

Source§

impl Clone for FrameMeta

Source§

fn clone(&self) -> FrameMeta

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 Copy for FrameMeta

Source§

impl Debug for FrameMeta

Source§

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

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

impl<'de> Deserialize<'de> for FrameMeta

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for FrameMeta

Source§

impl PartialEq for FrameMeta

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for FrameMeta

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for FrameMeta

Auto Trait Implementations§

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more