Struct twilight_gateway::shard::Config

pub struct Config { /* fields omitted */ }

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

Use Shard::builder to start creating a configured shard.

Implementations

impl Config

pub const fn event_types(&self) -> EventTypeFlags

Copy of the event type flags.

pub fn gateway_url(&self) -> Option<&str>

Return an immutable reference to the url used to connect to the gateway.

pub const fn http_client(&self) -> &Client

Return an immutable reference to the twilight_http client to be used by the shard.

pub const fn intents(&self) -> Intents

Return a copy of the intents that the gateway is using.

pub const fn large_threshold(&self) -> u64

Return the maximum threshold at which point the gateway will stop sending a guild’s member list in Guild Create events.

pub const fn presence(&self) -> Option<&UpdatePresencePayload>

Return an immutable reference to the presence to set when identifying with the gateway.

This will be the bot’s presence. For example, setting the online status to Do Not Disturb will show the status in the bot’s presence.

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

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

pub const fn token(&self) -> &str

Return an immutable reference to the token used to authenticate with when identifying with the gateway.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.