Struct Latency

pub struct Latency { /* private fields */ }

Shard’s gateway connection latency.

Measures the difference between sending a heartbeat and receiving an acknowledgement, also known as a heartbeat period. Spurious heartbeat acknowledgements are ignored.

May be obtained via Shard::latency.

Implementations

impl Latency

pub const fn average(&self) -> Option<Duration>

Average latency.

For example, a reasonable value for this may be between 10 to 100 milliseconds depending on the network connection and physical location.

Returns None if no heartbeat periods have been recorded.

pub const fn periods(&self) -> u32

Number of recorded heartbeat periods.

pub fn recent(&self) -> &[Duration]

Most recent latencies from newest to oldest.

pub const fn received(&self) -> Option<Instant>

When the last heartbeat received an acknowledgement.

pub const fn sent(&self) -> Option<Instant>

When the last heartbeat was sent.

Trait Implementations

impl Clone for Latency

fn clone(&self) -> Latency

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Latency

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

Formats the value using the given formatter.