Enum twilight_gateway::cluster::config::ShardScheme

pub enum ShardScheme {
    Auto,
    Range {
        from: u64,
        to: u64,
        total: u64,
    },
}

The method of sharding to use.

By default this is Auto.

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::config::ShardScheme;
use std::convert::TryFrom;

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

Fields of Range

from: u64

The first shard ID to spawn.

to: u64

The last shard ID to spawn.

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

total: u64

The total number of shards used by the bot.

Trait Implementations

impl Clone for ShardScheme

fn clone(&self) -> ShardScheme

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ShardScheme

impl Debug for ShardScheme

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

Formats the value using the given formatter.

impl Default for ShardScheme

fn default() -> Self

Returns the "default value" for a type.

impl Eq for ShardScheme

impl Hash for ShardScheme

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl Ord for ShardScheme

fn cmp(&self, other: &ShardScheme) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<ShardScheme> for ShardScheme

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

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

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

This method tests for !=.

impl PartialOrd<ShardScheme> for ShardScheme

fn partial_cmp(&self, other: &ShardScheme) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for ShardScheme

impl StructuralPartialEq for ShardScheme

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

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.