Enum twilight_gateway::cluster::ShardScheme

#[non_exhaustive]pub enum ShardScheme {
    Auto,
    Range {
        from: u64,
        to: u64,
        total: u64,
    },
}

The method of sharding to use.

By default this is Auto.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Auto

Specifies to retrieve the amount of shards recommended by Discord and then start all of them.

For example, if Discord recommends 10 shards, then all 10 shards will be started.

Range

Specifies to start a range of shards.

Examples

For example, if your bot uses 50 shards, then you might specify to start shards 0 through 24:

use twilight_gateway::cluster::ShardScheme;
use std::convert::TryFrom;

let range = ShardScheme::try_from((0..24, 50))?;

Fields of Range

from: u64

First shard ID to spawn.

to: u64

Last shard ID to spawn.

This doesn't necessarily have to be up to the total.

total: u64

Total number of shards used by the bot.

Trait Implementations

impl Clone for ShardScheme

pub fn clone(&self) -> ShardScheme

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ShardScheme

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

Formats the value using the given formatter.

impl Default for ShardScheme

pub fn default() -> Self

Returns the "default value" for a type.

impl Eq for ShardScheme

impl Hash for ShardScheme

pub fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<ShardScheme> for ShardScheme

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralEq for ShardScheme

impl StructuralPartialEq for ShardScheme

impl<T: RangeBounds<u64>> TryFrom<(T, u64)> for ShardScheme

type Error = ShardSchemeRangeError

The type returned in the event of a conversion error.

pub fn try_from((range, total): (T, u64)) -> Result<Self, Self::Error>

Performs the conversion.