pub struct StreamState {
pub phase: StreamPhase,
pub frames_seen: u64,
}Expand description
The published state of one video stream: its lifecycle phase
and the number of source frames seen so far. The video participant
publishes it per stream; clients subscribe, hence state.
Fields§
§phase: StreamPhase§frames_seen: u64Trait Implementations§
Source§impl Clone for StreamState
impl Clone for StreamState
Source§fn clone(&self) -> StreamState
fn clone(&self) -> StreamState
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl ContractBody for StreamState
impl ContractBody for StreamState
Source§const NAME: &'static str = "v1::video::stream::StreamState"
const NAME: &'static str = "v1::video::stream::StreamState"
The version-qualified type path this body’s own version module
places it at: the version module name, then the
::-joined node path
(dynamic-node vars are topic params, never type-path segments), then
the PascalCase type leaf, e.g. "v1::drive::Target" or
"v1::component::motor::Command". This is the contract’s source
identity (D1) - two contracts interoperate iff they share this exact
name - as distinct from TOPIC, the resolved
wire key derived from it. NAME is exactly the "::"-join of
VERSION and
CONTRACT; it stays available for callers
that want the whole identity as one string (e.g. display), while
metadata recording splices the two split consts instead (coherence-gate
design doc §2 - a joined name is not machine-parseable without
assuming the version naming scheme).Source§const VERSION: &'static str = "v1"
const VERSION: &'static str = "v1"
This body’s version alone, e.g.
"v1" - equal to
<Self::Api as ApiVersion>::ID, but exposed directly on the body so a
metadata recorder (#[derive(phoxal::Api)]’s linker-section
splicing) can const-splice it without routing through Self::Api.
Split from CONTRACT so consumers (the
coherence gate, catalog) record version and contract as two
separate fields rather than parsing a joined name.Source§const CONTRACT: &'static str = "video::stream::StreamState"
const CONTRACT: &'static str = "video::stream::StreamState"
This body’s contract path within its own version: the
::-joined
node path (dynamic-node vars excluded, as with NAME) plus the
PascalCase type leaf, e.g. "drive::Target". The logical
contract - stable across a version bump - is this value alone;
pairing it with VERSION recovers the
full version-qualified identity (NAME).Source§const TOPIC: &'static str = "v1/video/stream/{stream}/state"
const TOPIC: &'static str = "v1/video/stream/{stream}/state"
The version-qualified wire key: the version module name, then the
/-joined node path plus the topic leaf, with each dynamic node
contributing a {var} placeholder, e.g. "v1/drive/state" or
"v1/component/{instance}/motor/{capability}/command". The concrete
key is produced by the api-local topic builder, which fills the
placeholders.Source§impl Debug for StreamState
impl Debug for StreamState
Source§impl<'de> Deserialize<'de> for StreamState
impl<'de> Deserialize<'de> for StreamState
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
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 PartialEq for StreamState
impl PartialEq for StreamState
Source§impl Serialize for StreamState
impl Serialize for StreamState
impl StructuralPartialEq for StreamState
Auto Trait Implementations§
impl Freeze for StreamState
impl RefUnwindSafe for StreamState
impl Send for StreamState
impl Sync for StreamState
impl Unpin for StreamState
impl UnsafeUnpin for StreamState
impl UnwindSafe for StreamState
Blanket Implementations§
Source§impl<Source> AccessAs for Source
impl<Source> AccessAs for Source
Source§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
Source§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> DeserializeOwned for Twhere
T: for<'de> Deserialize<'de>,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more