twilight_gateway/
command.rs

1//! Sealed Command trait to denote what can be provided to [`Shard::command`].
2//!
3//! [`Shard::command`]: crate::Shard::command
4
5use twilight_model::gateway::payload::outgoing::{
6    RequestGuildMembers, UpdatePresence, UpdateVoiceState,
7};
8
9mod private {
10    //! Private module to provide a sealed trait depended on by [`Command`],
11    //! disallowing consumers from implementing it.
12    //!
13    //! [`Command`]: super::Command
14
15    use serde::Serialize;
16    use twilight_model::gateway::payload::outgoing::{
17        RequestGuildMembers, UpdatePresence, UpdateVoiceState,
18    };
19
20    /// Sealed trait to prevent users from implementing the Command trait.
21    pub trait Sealed: Serialize {}
22
23    impl Sealed for RequestGuildMembers {}
24    impl Sealed for UpdatePresence {}
25    impl Sealed for UpdateVoiceState {}
26}
27
28/// Trait marker denoting what can be provided to [`Shard::command`].
29///
30/// This trait exists to make it easier to determine what commands can be sent
31/// to the Discord Gateway API.
32///
33/// This is deliberately not implemented for [`Heartbeat`], [`Identify`], and
34/// [`Resume`] due to shards automatically sending them as necessary.
35///
36/// To send an arbitrary command to the Discord Gateway API then [`Shard::send`]
37/// may be used.
38///
39/// [`Heartbeat`]: twilight_model::gateway::payload::outgoing::Heartbeat
40/// [`Identify`]: twilight_model::gateway::payload::outgoing::Identify
41/// [`Resume`]: twilight_model::gateway::payload::outgoing::Resume
42/// [`Shard::command`]: crate::Shard::command
43/// [`Shard::send`]: crate::Shard::send
44pub trait Command: private::Sealed {}
45
46impl Command for RequestGuildMembers {}
47impl Command for UpdatePresence {}
48impl Command for UpdateVoiceState {}
49
50#[cfg(test)]
51mod tests {
52    use super::Command;
53    use static_assertions::assert_impl_all;
54    use twilight_model::gateway::payload::outgoing::{
55        RequestGuildMembers, UpdatePresence, UpdateVoiceState,
56    };
57
58    assert_impl_all!(RequestGuildMembers: Command);
59    assert_impl_all!(UpdatePresence: Command);
60    assert_impl_all!(UpdateVoiceState: Command);
61}
twilight_gateway/command.rs

twilight_gateway/
command.rs
