Struct Stats

pub struct Stats { /* private fields */ }

A struct representing a Discord bot’s statistics.

Examples

Solely from a server count:

use topgg::Stats;

let _stats = Stats::from(12345);

Server count with a shard count:

use topgg::Stats;

let server_count = 12345;
let shard_count = 10;
let _stats = Stats::from_count(server_count, Some(shard_count));

Solely from shards information:

use topgg::Stats;

// the shard posting this data has 456 servers.
let _stats = Stats::from_shards([123, 456, 789], Some(1));

Implementations

impl Stats

pub fn shards(&self) -> &[usize]

An array of this Discord bot’s server count for each shard.

pub fn shard_count(&self) -> usize

The amount of shards this Discord bot has.

pub fn server_count(&self) -> Option<usize>

The amount of servers this bot is in. None if such information is publy unavailable.

impl Stats

pub fn from_context(context: &Context) -> Self

Available on crate feature serenity-cached only.

Creates a Stats struct from the cache of a serenity Context.

pub const fn from_count(server_count: usize, shard_count: Option<usize>) -> Self

Creates a Stats struct based on total server and optionally, shard count data.

pub fn from_shards<A>(shards: A, shard_index: Option<usize>) -> Self

where A: IntoIterator<Item = usize>,

Creates a Stats struct based on an array of server count per shard and optionally the index (to the array) of shard posting this data.

Panics

Panics if the shard_index argument is Some yet it’s out of range of the shards array.

Examples

Basic usage:

use topgg::Stats;

// the shard posting this data has 456 servers.
let _stats = Stats::from_shards([123, 456, 789], Some(1));

Trait Implementations

impl Clone for Stats

fn clone(&self) -> Stats

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Stats

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Stats

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<usize> for Stats

Creates a Stats struct solely from a server count.

fn from(server_count: usize) -> Self

Converts to this type from the input type.

impl Serialize for Stats

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

where __S: Serializer,

Serialize this value into the given Serde serializer.