Skip to main content

Crate vivid_protocol

Crate vivid_protocol 

Source
Expand description

Framing, deterministic control-message codecs, and media record layouts for the Vivid terminal media protocol.

This crate is transport- and renderer-independent. Producers and presenters share it to keep the Vivid version, numeric registries, validation limits, and binary layouts synchronized.

Modules§

anchor
Authenticated terminal anchor marker version 3.
auth
Vivid 1.5 authentication proofs and session-key derivation.
cbor
context
Context authority and finite delegated resource schemas.
discovery
Native Vivid 1.5 endpoint and root-secret discovery.
geometry
Shared fixed-point geometry for target-profile scene placement and desktop coordinate mapping.
grant
Presenter-side desktop input grants.
hid
The HID keyboard-page usages desktop §7 carries, keyed by the web’s physical-key name.
idempotency
Bounded idempotency-result storage scoped to one logical session.
identity
Complete owner-scoped identities for Vivid 1.5 state and cleanup.
input
Generation-checked desktop input schemas and final-injection gating.
lease
Retry-safe delegated session leases, suspension, and bounded resume state.
media
messages
Deterministic Vivid 1.5 control-message codecs.
observation
Bounded, coalescing observation delivery.
registry
Append-only Vivid 1.5 numeric and profile registries.
resource
Finite resource contracts and channel-local absolute flow accounting.
revision
Checked Vivid 1.5 revision and generation domains.
scene
Owner-scoped retained scenes with atomic transactions.
surface
Stable surface schemas and generation-safe mutation helpers.
target
Presentation-target descriptors and the target-generation advance rules.
time
A monotonic instant the protocol never reads for itself.
trace
Bounded, metadata-only diagnostics shared by Vivid components.
track
Immutable track configuration, channel generations, and readiness state.
web
The finite ceilings a browser carrier imposes, web §5.2.
wire

Constants§

CONTROL_MAX_RECORD_BODY
DEFAULT_MAX_RECORD_BODY
HARD_MAX_RECORD_BODY
MAX_TRACK_WAIT_TIMEOUT_US
Maximum timeout carried by one correlated WAIT_TRACK request.
VIVID_MAJOR
Version of the Vivid wire protocol, used by both the connection preface and HELLO/WELCOME.
VIVID_MINOR