Struct twilight_gateway::stream::ShardMessageStream

pub struct ShardMessageStream<'a> { /* private fields */ }

Stream selecting the next websocket message from a collection of shards.

Examples

Create the recommended number of shards and stream over their messages:

use futures::StreamExt;
use std::env;
use twilight_gateway::{
    stream::{self, ShardMessageStream},
    Config, Intents,
};
use twilight_http::Client;

let token = env::var("DISCORD_TOKEN")?;
let client = Client::new(token.clone());
let config = Config::new(token.clone(), Intents::GUILDS);

let mut shards = stream::create_recommended(&client, config, |_, builder| builder.build())
    .await?
    .collect::<Vec<_>>();

let mut stream = ShardMessageStream::new(shards.iter_mut());

while let Some((shard, event)) = stream.next().await {
    let message = match event {
        Ok(message) => message,
        Err(source) => {
            tracing::warn!(?source, "error receiving message");

            if source.is_fatal() {
                break;
            }

            continue;
        }
    };

    tracing::debug!(?message, shard = ?shard.id(), "received message");
}

Implementations

impl<'a> ShardMessageStream<'a>

pub fn new(shards: impl Iterator<Item = &'a mut Shard>) -> Self

Create a new stream producing websocket messages from a set of shards.

Trait Implementations

impl<'a> Stream for ShardMessageStream<'a>

type Item = (ShardRef<'a>, Result<Message, ReceiveMessageError>)

Values yielded by the stream.

fn poll_next(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.