Struct twilight_gateway::shard::Latency

pub struct Latency { /* fields omitted */ }

Information about the latency of a Shard's websocket connection.

This is obtained through Shard::info.

Implementations

impl Latency

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

The average time it took to receive an acknowledgement for every heartbeat sent over the duration of the session.

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

Note

If this is None, the shard has not received a heartbeat yet.

pub fn heartbeats(&self) -> u32

The total number of heartbeats that have been sent during this session.

pub fn recent(&self) -> &VecDeque<Duration>

The 5 most recent latency times.

Index 0 is the oldest, 4 is the most recent.

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

When the last heartbeat acknowledgement was received.

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

When the last heartbeat was sent.

Trait Implementations

impl Clone for Latency

pub fn clone(&self) -> Latency

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Latency

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Latency

pub fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for Latency

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

Serialize this value into the given Serde serializer.