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

pub enum ShardRunnerMessage {
    ChunkGuild {
        guild_id: GuildId,
        limit: Option<u16>,
        filter: ChunkGuildFilter,
        nonce: Option<String>,
    },
    Close(u16, Option<String>),
    Message(Message),
    SetActivity(Option<Activity>),
    SetPresence(OnlineStatus, Option<Activity>),
    SetStatus(OnlineStatus),
}

A message to send from a shard over a WebSocket.

Variants

ChunkGuild

Fields

guild_id: GuildId

The IDs of the Guild to chunk.

limit: Option<u16>

The maximum number of members to receive GuildMembersChunkEvents for.

filter: ChunkGuildFilter

A filter to apply to the returned members.

nonce: Option<String>

Optional nonce to identify GuildMembersChunkEvent responses.

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

Close(u16, Option<String>)

Tuple Fields

0: u16

1: 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(Message)

Tuple Fields

0: Message

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

SetActivity(Option<Activity>)

Tuple Fields

0: Option<Activity>

Indicates that the client is to update the shard’s presence’s activity.

SetPresence(OnlineStatus, Option<Activity>)

Tuple Fields

0: OnlineStatus

1: Option<Activity>

Indicates that the client is to update the shard’s presence in its entirity.

SetStatus(OnlineStatus)

Tuple Fields

0: 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.