Struct twilight_gateway::shard::config::ShardConfigBuilder

pub struct ShardConfigBuilder(_);

Builder to create a ShardConfig.

Implementations

impl ShardConfigBuilder

pub fn new(token: impl Into<String>) -> Self

Creates a new builder with default configuration values.

Refer to each method to learn their default values.

pub fn build(self) -> ShardConfig

Consumes the builder and returns the final configuration.

pub fn http_client(self, http_client: HttpClient) -> Self

The HTTP client to be used by the shard for getting gateway information.

pub fn intents(&mut self, intents: Option<GatewayIntents>) -> &mut Self

Sets the gateway intents.

pub fn large_threshold(self, large_threshold: u64) -> Result<Self>

The maximum number of members in a guild to load the member list.

If you pass 200, then if there are 250 members in a guild the member list won't be sent. If there are 150 members, then the list will be sent.

The default value is 250. The minimum value is 50 and the maximum is 250.

Errors

Returns Error::LargeThresholdInvalid if the provided value was below 50 or above 250.

pub fn presence(self, presence: UpdateStatusInfo) -> Self

Sets the presence to use automatically when starting a new session.

The default is none, which defaults to strictly being "online" with no special qualities.

pub fn queue(self, queue: Arc<Box<dyn Queue>>) -> Self

Sets the queue to use for queueing shard connections.

You probably don't need to set this yourself, because the Cluster manages that for you. You only need to set this if you're implementing your only cluster-like support.

The default value is a queue used only by this shard, or a queue used by all shards when ran by a Cluster.

pub fn shard(self, shard_id: u64, shard_total: u64) -> Result<Self>

Sets the shard ID to connect as, and the total number of shards used by the bot.

The shard ID is 0-indexed, while the total is 1-indexed.

The default value is a shard ID of 0 and a shard total of 1, which is good for smaller bots.

Note: If your bot is in over 100'000 guilds then shard_total should probably be a multiple of 16 if you're in the "Large Bot Sharding" program.

Errors

If you have 19 shards, then your last shard will have an ID of 18 out of a total of 19 shards:

use twilight_gateway::shard::ShardConfig;
use std::env;

let mut config = ShardConfig::builder(env::var("DISCORD_TOKEN")?);
config.shard(18, 19)?;

Errors

Returns Error::IdTooLarge if the shard ID to connect as is larger than the total.

Trait Implementations

impl Debug for ShardConfigBuilder

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

Formats the value using the given formatter.

impl From<ShardConfigBuilder> for ShardConfig

fn from(builder: ShardConfigBuilder) -> Self

Performs the conversion.

impl<T: Into<String>> From<T> for ShardConfigBuilder

fn from(token: T) -> Self

Performs the conversion.