Struct twilight_gateway::cluster::Cluster

pub struct Cluster(_);

A manager for multiple shards.

The Cluster can be cloned and will point to the same cluster, so you can pass it around as needed.

Cloning

The cluster internally wraps its data within an Arc. This means that the cluster can be cloned and passed around tasks and threads cheaply.

Examples

Refer to the module-level documentation for examples.

Implementations

impl Cluster

pub async fn new(
    token: impl Into<String>,
    intents: Intents
) -> Result<(Self, Events), ClusterStartError>

Create a new unconfigured cluster.

Use builder to configure and construct a cluster.

Examples

Create a cluster, receiving a stream of events:

use twilight_gateway::{Cluster, EventTypeFlags, Event, Intents};
use futures::StreamExt;
use std::env;

let types = EventTypeFlags::MESSAGE_CREATE
    | EventTypeFlags::MESSAGE_DELETE
    | EventTypeFlags::MESSAGE_UPDATE;

let (cluster, mut events) = Cluster::builder(env::var("DISCORD_TOKEN")?, Intents::GUILD_MESSAGES)
    .event_types(types)
    .build()
    .await?;
cluster.up().await;

while let Some((shard_id, event)) = events.next().await {
    match event {
        Event::MessageCreate(_) => println!("Shard {} got a new message", shard_id),
        Event::MessageDelete(_) => println!("Shard {} got a deleted message", shard_id),
        Event::MessageUpdate(_) => println!("Shard {} got an updated message", shard_id),
        // No other events will come in through the stream.
        _ => {},
    }
}

Errors

Returns a ClusterStartErrorType::RetrievingGatewayInfo error type if there was an HTTP error Retrieving the gateway information.

pub fn builder(token: impl Into<String>, intents: Intents) -> ClusterBuilder

Create a builder to configure and construct a cluster.

Examples

Create a cluster, receiving a stream of events when a message is created, deleted, or updated:

use twilight_gateway::{Cluster, EventTypeFlags, Event, Intents};
use futures::StreamExt;
use std::env;

let token = env::var("DISCORD_TOKEN")?;
let types = EventTypeFlags::MESSAGE_CREATE
    | EventTypeFlags::MESSAGE_DELETE
    | EventTypeFlags::MESSAGE_UPDATE;

let (cluster, mut events) = Cluster::builder(token, Intents::GUILD_MESSAGES)
    .event_types(types)
    .build()
    .await?;
cluster.up().await;

while let Some((shard_id, event)) = events.next().await {
    match event {
        Event::MessageCreate(_) => println!("Shard {} got a new message", shard_id),
        Event::MessageDelete(_) => println!("Shard {} got a deleted message", shard_id),
        Event::MessageUpdate(_) => println!("Shard {} got an updated message", shard_id),
        // No other events will come in through the stream.
        _ => {},
    }
}

pub fn config(&self) -> &Config

Return an immutable reference to the configuration of this cluster.

pub async fn up(&self)

Bring up the cluster, starting all of the shards that it was configured to manage.

Examples

Bring up a cluster, starting shards all 10 shards that a bot uses:

use twilight_gateway::{cluster::{Cluster, ShardScheme}, Intents};
use std::{
    convert::TryFrom,
    env,
};

let token = env::var("DISCORD_TOKEN")?;
let scheme = ShardScheme::try_from((0..=9, 10))?;
let (cluster, _) = Cluster::builder(token, Intents::GUILD_MESSAGES)
    .shard_scheme(scheme)
    .build()
    .await?;

// Finally, bring up the cluster.
cluster.up().await;

pub fn down(&self)

Bring down the cluster, stopping all of the shards that it’s managing.

pub fn down_resumable(&self) -> HashMap<u64, ResumeSession>

Bring down the cluster in a resumable way and returns all info needed for resuming.

The returned map is keyed by the shard’s ID to the information needed to resume. If a shard can’t resume, then it is not included in the map.

Note: Discord only allows resuming for a few minutes after disconnection. You may also not be able to resume if you missed too many events already.

pub fn shard(&self, id: u64) -> Option<Shard>

Return a Shard by its ID.

pub fn shards(&self) -> Vec<Shard>

Return a list of all the shards.

pub fn info(&self) -> HashMap<u64, Information>

Return information about all shards.

Examples

After waiting a minute, print the ID, latency, and stage of each shard:

use twilight_gateway::{Cluster, Intents};
use std::{env, time::Duration};

let (cluster, _) = Cluster::new(env::var("DISCORD_TOKEN")?, Intents::empty()).await?;
cluster.up().await;

tokio::time::sleep(Duration::from_secs(60)).await;

for (shard_id, info) in cluster.info() {
    println!(
        "Shard {} is {} with an average latency of {:?}",
        shard_id,
        info.stage(),
        info.latency().average(),
    );
}

pub async fn command(
    &self,
    id: u64,
    value: &impl Serialize
) -> Result<(), ClusterCommandError>

Send a command to the specified shard.

Errors

Returns a ClusterCommandErrorType::Sending error type if the shard exists, but sending it failed.

Returns a ClusterCommandErrorType::ShardNonexistent error type if the provided shard ID does not exist in the cluster.

pub async fn command_raw(
    &self,
    id: u64,
    value: Vec<u8>
) -> Result<(), ClusterCommandError>

👎 Deprecated since 0.3.0:

Use send which is more versatile

Send a raw command to the specified shard.

Errors

Returns a ClusterCommandErrorType::Sending error type if the shard exists, but sending it failed.

Returns a ClusterCommandErrorType::ShardNonexistent error type if the provided shard ID does not exist in the cluster.

pub async fn send(
    &self,
    id: u64,
    message: Message
) -> Result<(), ClusterSendError>

Send a raw websocket message.

Examples

Send a restart close to shard ID 7:

use std::env;
use twilight_gateway::{
    cluster::Cluster,
    shard::raw_message::{CloseFrame, Message},
    Intents,
};

let token = env::var("DISCORD_TOKEN")?;
let (cluster, _) = Cluster::new(token, Intents::GUILDS).await?;
cluster.up().await;

// some time later..
let close = CloseFrame::from((1012, ""));
let message = Message::Close(Some(close));
cluster.send(7, message).await?;

Errors

Returns ClusterCommandErrorType::Sending error type if the shard exists, but sending the close code failed.

Returns a ClusterCommandErrorType::ShardNonexistent error type if the provided shard ID does not exist in the cluster.

Trait Implementations

impl Clone for Cluster

fn clone(&self) -> Cluster

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Cluster

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

Formats the value using the given formatter.