Enum serenity::gateway::ConnectionStage [−][src]
#[non_exhaustive]
pub enum ConnectionStage {
Connected,
Connecting,
Disconnected,
Handshake,
Identifying,
Resuming,
}
Expand description
Indicates the current connection stage of a Shard
.
This can be useful for knowing which shards are currently “down”/“up”.
Variants (Non-exhaustive)
This enum is marked as non-exhaustive
Connected
Indicator that the Shard
is normally connected and is not in, e.g.,
a resume phase.
Connecting
Indicator that the Shard
is connecting and is in, e.g., a resume
phase.
Disconnected
Indicator that the Shard
is fully disconnected and is not in a
reconnecting phase.
Handshake
Indicator that the Shard
is currently initiating a handshake.
Identifying
Indicator that the Shard
has sent an IDENTIFY packet and is awaiting
a READY packet.
Resuming
Indicator that the Shard
has sent a RESUME packet and is awaiting a
RESUMED packet.
Implementations
Whether the stage is a form of connecting.
This will return true
on:
All other variants will return false
.
Examples
Assert that ConnectionStage::Identifying
is a connecting stage:
use serenity::gateway::ConnectionStage;
assert!(ConnectionStage::Identifying.is_connecting());
Assert that ConnectionStage::Connected
is not a connecting stage:
use serenity::gateway::ConnectionStage;
assert!(!ConnectionStage::Connected.is_connecting());
Trait Implementations
This method returns an ordering between self
and other
values if one exists. Read more
This method tests less than (for self
and other
) and is used by the <
operator. Read more
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
Auto Trait Implementations
impl RefUnwindSafe for ConnectionStage
impl Send for ConnectionStage
impl Sync for ConnectionStage
impl Unpin for ConnectionStage
impl UnwindSafe for ConnectionStage
Blanket Implementations
Mutably borrows from an owned value. Read more
Compare self to key
and return true
if they are equal.
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more