Struct twilight_gateway::shard::config::ShardConfig

pub struct ShardConfig { /* fields omitted */ }

The configuration used by the shard to identify with the gateway and operate.

Use ShardConfig::builder to start creating a configuration.

Implementations

impl ShardConfig

pub fn builder(token: impl Into<String>) -> ShardConfigBuilder

Creates a new builder to create a config.

This is equivalent to calling ShardConfigBuilder::new directly.

pub fn http_client(&self) -> &HttpClient

Returns the twilight_http client to be used by the shard.

pub fn intents(&self) -> Option<&GatewayIntents>

Returns the intents that the gateway is using.

pub fn large_threshold(&self) -> u64

The maximum threshold at which point the gateway will stop sending a guild's member list.

pub fn presence(&self) -> Option<&UpdateStatusInfo>

The presence to set when connecting to the gateway.

This will be the bot's presence. For example, setting an activity in the presence will show the activity in the bot's status.

pub fn shard(&self) -> [u64; 2]

The shard's ID and the total number of shards used by the bot.

pub fn token(&self) -> &str

The token used to authenticate with when identifying with the gateway.

Trait Implementations

impl Clone for ShardConfig

fn clone(&self) -> ShardConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ShardConfig

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 ShardConfig

fn from(token: T) -> Self

Performs the conversion.