Struct twilight_gateway::Config

pub struct Config { /* private fields */ }

Configuration used by the shard to identify with the gateway and operate.

Use Config::builder to configure a shard’s configuration.

May be reused by cloning, also reusing the hidden TLS context—reducing memory usage. The TLS context may still be reused with an otherwise different config by turning it into to a ConfigBuilder through the From<Config> implementation and then rebuilding it into a rew config.

Implementations

impl Config

pub fn new(token: String, intents: Intents) -> Self

Create a new default shard configuration.

Shortcut for calling builder and immediately finalizing the builder.

Panics

Panics if loading TLS certificates fails.

pub fn builder(token: String, intents: Intents) -> ConfigBuilder

Create a builder to customize a shard’s configuration.

Panics

Panics if loading TLS certificates fails.

pub const fn event_types(&self) -> EventTypeFlags

Event type flags.

pub const fn identify_properties(&self) -> Option<&IdentifyProperties>

Immutable reference to the identification properties the shard will use.

pub const fn intents(&self) -> Intents

Intents that the shard requests when identifying with the gateway.

pub const fn large_threshold(&self) -> u64

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>

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 fn proxy_url(&self) -> Option<&str>

Immutable reference to the gateway proxy URL.

pub fn queue(&self) -> &Arc<dyn Queue>

Immutable reference to the queue in use by the shard.

pub const fn ratelimit_messages(&self) -> bool

Whether outgoing message ratelimiting is enabled.

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

Immutable reference to the token used to authenticate 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.

impl From<Config> for ConfigBuilder

fn from(value: Config) -> Self

Converts to this type from the input type.