Struct Health 

pub struct Health {
    pub connected: bool,
    pub last_message_ms: Option<i64>,
    pub clock_offset_ms: i64,
    pub rate_budget_used: u32,
    pub reconnects: u64,
}

A snapshot of a connection’s health.

Fields

connected: bool

Whether the stream is currently connected.

last_message_ms: Option<i64>

Timestamp (ms since the Unix epoch) of the last received message.

clock_offset_ms: i64

The current server-clock offset in milliseconds.

rate_budget_used: u32

Weight charged against the rate budget in the current window.

reconnects: u64

How many times the stream has reconnected.

Implementations

impl Health

pub fn staleness_ms(&self, now_ms: i64) -> Option<i64>

Milliseconds since the last message at now_ms, or None if no message has been received yet.

pub fn is_healthy(&self, now_ms: i64, max_staleness_ms: i64) -> bool

Whether the connection is healthy: connected and a message arrived within max_staleness_ms.

Trait Implementations

impl Clone for Health

fn clone(&self) -> Health

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Health

impl Debug for Health

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

Formats the value using the given formatter.

impl Default for Health

fn default() -> Health

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Health

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Health

impl PartialEq for Health

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Health

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Health