Struct twilight_gateway::cluster::config::ClusterConfig

[+] Show declaration

pub struct ClusterConfig { /* fields omitted */ }

[−] Expand description

Built configuration to be used for creating a Cluster.

Implementations

impl ClusterConfig[−]

pub fn builder(token: impl Into<String>) -> ClusterConfigBuilder[−]

Creates a new builder to create a config.

This is equivalent to calling ClusterConfigBuilder::new directly.

pub fn http_client(&self) -> &Client[−]

Returns the twilight_http client used by the cluster and shards to get the gateway information.

Refer to ClusterConfigBuilder::http_client for the default value.

pub fn shard_config(&self) -> &ShardConfig[−]

Returns the configuration used to create shards.

Refer to shard::config::ClusterConfigBuilder's methods for the default values.

pub fn shard_scheme(&self) -> ShardScheme[−]

Returns the shard scheme used to start shards.

Refer to ClusterConfigBuilder::shard_scheme for the default value.

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

pub fn resume_sessions(&self) -> &HashMap<u64, ResumeSession>[−]

Returns the resume data to resume shards for this cluster

Refer to ClusterConfigBuilder::resume_sessions for the default value.

Trait Implementations

impl Debug for ClusterConfig[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl From<ClusterConfigBuilder> for ClusterConfig[+]

[+] Show hidden undocumented items

fn from(builder: ClusterConfigBuilder) -> Self[−]

Performs the conversion.

impl<T: Into<String>> From<T> for ClusterConfig[+]

[+] Show hidden undocumented items

fn from(token: T) -> Self[−]

Performs the conversion.