Skip to main content

StreamInspectorSnapshot

Struct StreamInspectorSnapshot 

Source
pub struct StreamInspectorSnapshot {
    pub stream_id: Symbol,
    pub route: Symbol,
    pub media: StreamMedia,
    pub profile: Symbol,
    pub clock: Symbol,
    pub status: StreamInspectorStatus,
    pub buffer: BufferPolicy,
    pub queue_depth: usize,
    pub dropped_count: u64,
    pub last_sequence: Option<u64>,
    pub recent_diagnostics: Vec<Symbol>,
}
Expand description

Point-in-time observation of a single stream’s identity and health.

Captures the stream’s metadata-derived identity (id, media, clock, buffer policy), its routing and transport profile, its current StreamInspectorStatus, and live queue/loss counters. Render with StreamInspectorSnapshot::to_expr to hand the snapshot to a codec.

Fields§

§stream_id: Symbol

Stable identifier of the observed stream.

§route: Symbol

Route the stream is being observed on.

§media: StreamMedia

Media kind carried by the stream.

§profile: Symbol

Name of the transport profile in effect.

§clock: Symbol

Clock domain the stream is timed against.

§status: StreamInspectorStatus

Current lifecycle status of the stream.

§buffer: BufferPolicy

Bounded buffer policy governing the stream’s queue.

§queue_depth: usize

Number of items currently queued in the buffer.

§dropped_count: u64

Total items dropped (newest plus oldest) since the stream opened.

§last_sequence: Option<u64>

Sequence number of the most recent observed item, if any.

§recent_diagnostics: Vec<Symbol>

Recent diagnostic symbols collected for the stream.

Implementations§

Source§

impl StreamInspectorSnapshot

Source

pub fn new( metadata: &StreamMetadata, route: Symbol, profile: Symbol, status: StreamInspectorStatus, queue_depth: usize, stats: &StreamStats, last_sequence: Option<u64>, recent_diagnostics: Vec<Symbol>, ) -> Self

Builds a snapshot from stream metadata, stats, and observed counters.

Source

pub fn from_stream_value( stream: &StreamValue, route: Symbol, profile: &TransportProfile, recent_diagnostics: Vec<Symbol>, ) -> Result<Self>

Builds a snapshot by querying a live StreamValue.

Reads the stream’s stats, queue depth, and completion flag to derive the last observed sequence and StreamInspectorStatus. Returns an error if any of those queries fail.

Source

pub fn to_expr(&self) -> Expr

Renders the snapshot as a tagged Expr map for codec round-tripping.

Trait Implementations§

Source§

impl Clone for StreamInspectorSnapshot

Source§

fn clone(&self) -> StreamInspectorSnapshot

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 Debug for StreamInspectorSnapshot

Source§

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

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

impl Eq for StreamInspectorSnapshot

Source§

impl PartialEq for StreamInspectorSnapshot

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for StreamInspectorSnapshot

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<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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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.