Struct twilight_gateway::shard::Information

pub struct Information { /* fields omitted */ }

Information about a shard, including its latency, current session sequence, and connection stage.

Implementations

impl Information

pub fn id(&self) -> u64

Return the ID of the shard.

pub fn latency(&self) -> &Latency

Return an immutable reference to the latency information for the shard.

This includes the average latency over all time, and the latency information for the 5 most recent heartbeats.

pub fn session_id(&self) -> Option<&str>

Return an immutable reference to the session ID of the shard.

pub fn seq(&self) -> u64

Current sequence of the connection.

This is the number of the event that was received this session (without reconnecting). A larger number typically correlates that the shard has been connected for a longer time, while a smaller number typically correlates to meaning that it's been connected for a less amount of time.

pub fn stage(&self) -> Stage

Current stage of the shard.

For example, once a shard is fully booted then it will be Connected.

Trait Implementations

impl Clone for Information

pub fn clone(&self) -> Information

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Information

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Information

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 Information

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

Serialize this value into the given Serde serializer.