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),
    SetEventFilter(EventFilter),
    SetMessageFilter(MessageFilter),
    SetReactionFilter(ReactionFilter),
    SetComponentInteractionFilter(ComponentInteractionFilter),
}

A message to send from a shard over a WebSocket.

Variants

ChunkGuild

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

Fields of ChunkGuild

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.

Close

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.

Tuple Fields of Close

0: u161: Option<String>

Message

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

Tuple Fields of Message

0: Message

SetActivity

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

Tuple Fields of SetActivity

0: Option<Activity>

SetPresence

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

Tuple Fields of SetPresence

0: OnlineStatus1: Option<Activity>

SetStatus

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

Tuple Fields of SetStatus

0: OnlineStatus

SetEventFilter

This is supported on crate feature collector only.

Sends a new filter for events to the shard.

Tuple Fields of SetEventFilter

0: EventFilter

SetMessageFilter

This is supported on crate feature collector only.

Sends a new filter for messages to the shard.

Tuple Fields of SetMessageFilter

0: MessageFilter

SetReactionFilter

This is supported on crate feature collector only.

Sends a new filter for reactions to the shard.

Tuple Fields of SetReactionFilter

0: ReactionFilter

SetComponentInteractionFilter

This is supported on crate features unstable_discord_api and collector only.

Sends a new filter for component interactions to the shard.

Tuple Fields of SetComponentInteractionFilter

0: ComponentInteractionFilter

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.