1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
use model::{
gateway::Game,
user::OnlineStatus,
id::GuildId
};
use websocket::message::OwnedMessage;
/// A message to send from a shard over a WebSocket.
#[derive(Clone, Debug)]
pub enum ShardRunnerMessage {
/// Indicates that the client is to send a member chunk message.
ChunkGuilds {
/// The IDs of the [`Guild`]s to chunk.
///
/// [`Guild`]: ../../../model/guild/struct.Guild.html
guild_ids: Vec<GuildId>,
/// The maximum number of members to receive [`GuildMembersChunkEvent`]s
/// for.
///
/// [`GuildMembersChunkEvent`]: ../../../model/event/struct.GuildMembersChunkEvent.html
limit: Option<u16>,
/// Text to filter members by.
///
/// For example, a query of `"s"` will cause only [`Member`]s whose
/// usernames start with `"s"` to be chunked.
///
/// [`Member`]: ../../../model/guild/struct.Member.html
query: 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.
///
/// [`ShardManager`]: struct.ShardManager.html
Close(u16, Option<String>),
/// Indicates that the client is to send a custom WebSocket message.
Message(OwnedMessage),
/// Indicates that the client is to update the shard's presence's game.
SetGame(Option<Game>),
/// Indicates that the client is to update the shard's presence in its
/// entirity.
SetPresence(OnlineStatus, Option<Game>),
/// Indicates that the client is to update the shard's presence's status.
SetStatus(OnlineStatus),
}