Cluster

Struct Cluster 

Source
pub struct Cluster { /* private fields */ }
Expand description

A Cluster manages multiple Gateway Shards.

The Cluster handles:

  • Spawning and managing shard tasks
  • Coordinating identify rate limiting across shards
  • Aggregating events from all shards

§Example

use titanium_gateway::{Cluster, ClusterConfig, ShardRange};
use titanium_model::Intents;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let config = ClusterConfig::new(
        "your-token",
        Intents::GUILDS | Intents::GUILD_MESSAGES,
        ShardRange::All { total: 1 },
    );

    let (cluster, mut events) = Cluster::new(config);
    cluster.start().await?;

    while let Ok((shard_id, event)) = events.recv_async().await {
        println!("Shard {}: {:?}", shard_id, event);
    }

    Ok(())
}

Implementations§

Source§

impl Cluster

Source

pub fn new(config: ClusterConfig) -> (Self, Receiver<(u16, Event<'static>)>)

Create a new Cluster.

Returns the Cluster and a receiver for events from all shards. Events are tagged with the shard ID they came from.

Source

pub async fn start(&self) -> Result<(), GatewayError>

Start all shards.

This spawns a task for each shard and begins connecting to Discord. Shards will connect with proper rate limiting based on max_concurrency.

Source

pub fn shard_state(&self, shard_id: u16) -> Option<ShardState>

Get the state of a specific shard.

Source

pub fn shard_latency(&self, shard_id: u16) -> Option<Duration>

Get the last measured latency for a specific shard.

Source

pub fn shard_ids(&self) -> Vec<u16>

Get all shard IDs managed by this cluster.

Source

pub fn send(&self, shard_id: u16, payload: Value) -> Result<(), GatewayError>

Send a raw payload to a specific shard.

Source

pub async fn shutdown(&self)

Shutdown all shards gracefully.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more