Struct Shard 

pub struct Shard { /* private fields */ }

A Discord Gateway shard.

Handles WebSocket connection, heartbeating, event dispatch, and automatic reconnection with session resumption.

Implementations

impl Shard

pub fn new(shard_id: u16, total_shards: u16, config: ShardConfig) -> Self

Create a new shard.

Arguments

• shard_id - This shard’s ID (0-indexed).
• total_shards - Total number of shards.
• config - Shard configuration.

pub fn with_rate_limiter( shard_id: u16, total_shards: u16, config: ShardConfig, rate_limiter: Arc<IdentifyRateLimiter>, ) -> Self

Create a new shard with a shared rate limiter.

pub fn shard_id(&self) -> u16

Get the shard ID.

pub fn total_shards(&self) -> u16

Get the total number of shards.

pub fn state(&self) -> ShardState

Get the current shard state.

pub fn sequence(&self) -> u64

Get the last sequence number.

pub fn shutdown(&self)

Request a graceful shutdown.

pub fn latency(&self) -> Option<Duration>

Get the last measured latency.

pub fn send_payload<T: Serialize>( &self, payload: &T, ) -> Result<(), GatewayError>

Send a raw payload to the gateway.

This is useful for sending voice state updates (Op 4) or presence updates (Op 3). Accepts any type that implements serde::Serialize.

pub async fn run( &self, event_tx: Sender<Event<'static>>, ) -> Result<(), GatewayError>

Run the shard event loop.

This will connect to Discord, handle events, and automatically reconnect on disconnection. Events are sent to the provided channel.

Arguments

• event_tx - Channel to send parsed events to.

Returns

Returns Ok(()) on graceful shutdown, or an error if unrecoverable.