Enum serenity::client::bridge::gateway::ShardRunnerMessage

pub enum ShardRunnerMessage {
    ChunkGuilds {
        guild_ids: Vec<GuildId>,
        limit: Option<u16>,
        query: Option<String>,
    },
    Close(u16, Option<String>),
    Message(OwnedMessage),
    SetGame(Option<Game>),
    SetPresence(OnlineStatus, Option<Game>),
    SetStatus(OnlineStatus),
}

A message to send from a shard over a WebSocket.

Variants

ChunkGuilds

Indicates that the client is to send a member chunk message.

Fields of ChunkGuilds

guild_ids: Vec<GuildId>	The IDs of the Guilds to chunk.
limit: Option<u16>	The maximum number of members to receive GuildMembersChunkEvents for.
query: Option<String>	Text to filter members by. For example, a query of "s" will cause only Members whose usernames start with "s" to be chunked.

Close(u16, Option<String>)

Indicates that the client is to close with the given status code and reason.

You should rarely - if ever - need this, but the option is available. Prefer to use the ShardManager to shutdown WebSocket clients if you are intending to send a 1000 close code.

Message(OwnedMessage)

Indicates that the client is to send a custom WebSocket message.

SetGame(Option<Game>)

Indicates that the client is to update the shard's presence's game.

SetPresence(OnlineStatus, Option<Game>)

Indicates that the client is to update the shard's presence in its entirety.

SetStatus(OnlineStatus)

Indicates that the client is to update the shard's presence's status.

Trait Implementations

impl Clone for ShardRunnerMessage

fn clone(&self) -> ShardRunnerMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ShardRunnerMessage

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

Formats the value using the given formatter.