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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
use crate::model::{
gateway::Activity,
id::{GuildId, UserId},
user::OnlineStatus,
};
#[cfg(feature = "collector")]
use crate::collector::{MessageFilter, ReactionFilter};
use async_tungstenite::tungstenite::Message;
#[derive(Clone, Debug)]
pub enum ChunkGuildFilter {
/// Returns all members of the guilds specified. Requires GUILD_MEMBERS intent.
None,
/// A common username prefix filter for the members returned.
Query(String),
/// A set of exact user IDs to query for.
UserIds(Vec<UserId>),
}
/// A message to send from a shard over a WebSocket.
// Once we can use `Box` as part of a pattern, we will reconsider boxing.
#[allow(clippy::large_enum_variant)]
#[derive(Clone, Debug)]
pub enum ShardRunnerMessage {
/// Indicates that the client is to send a member chunk message.
ChunkGuild {
/// The IDs of the [`Guild`] to chunk.
///
/// [`Guild`]: ../../../model/guild/struct.Guild.html
guild_id: GuildId,
/// The maximum number of members to receive [`GuildMembersChunkEvent`]s
/// for.
///
/// [`GuildMembersChunkEvent`]: ../../../model/event/struct.GuildMembersChunkEvent.html
limit: Option<u16>,
/// A filter to apply to the returned members.
filter: ChunkGuildFilter,
/// Optional nonce to identify [`GuildMembersChunkEvent`] responses.
///
/// [`GuildMembersChunkEvent`]: ../../../model/event/struct.GuildMembersChunkEvent.html
nonce: 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(Message),
/// Indicates that the client is to update the shard's presence's activity.
SetActivity(Option<Activity>),
/// Indicates that the client is to update the shard's presence in its
/// entirity.
SetPresence(OnlineStatus, Option<Activity>),
/// Indicates that the client is to update the shard's presence's status.
SetStatus(OnlineStatus),
/// Sends a new filter for messages to the shard.
#[cfg(feature = "collector")]
SetMessageFilter(MessageFilter),
/// Sends a new filter for reactions to the shard.
#[cfg(feature = "collector")]
SetReactionFilter(ReactionFilter),
}