Enum discord_sdk::Event

pub enum Event {
Show 21 variants    Error(ErrorPayload),
    Ready(ConnectEvent),
    Disconnected {
        reason: Error,
    },
    CurrentUserUpdate(UpdateEvent),
    SpeakingStart(SpeakingEvent),
    SpeakingStop(SpeakingEvent),
    LobbyMemberConnect(MemberEvent),
    LobbyMemberDisconnect(MemberEvent),
    LobbyDelete {
        id: LobbyId,
    },
    LobbyUpdate(Lobby),
    LobbyMemberUpdate(MemberEvent),
    LobbyMessage(MessageEvent),
    LobbyCreate(Lobby),
    LobbyConnect(Lobby),
    ActivityJoin(SecretEvent),
    ActivitySpectate(SecretEvent),
    ActivityJoinRequest(JoinRequestEvent),
    ActivityInvite(InviteEvent),
    OverlayUpdate(UpdateEvent),
    RelationshipUpdate(Arc<Relationship>),
    VoiceSettingsUpdate(VoiceSettingsUpdateEvent),
}

Expand description

An event sent from Discord to notify us of some kind of state change or completed action.

{ "evt": "ACTIVITY_JOIN", "data": { "secret": "super_sekret" } }

Variants§

Error(ErrorPayload)

Fires when we’ve done something naughty and Discord is telling us to stop.

Ready(ConnectEvent)

Sent by Discord upon receipt of our Handshake message, the user is the current user logged in to the Discord we connected to.

Disconnected

Fields

§reason: Error

Fired when the connection has been interrupted between us and Discord, this is a synthesized event as there are can be numerous reasons on the client side for this to happen, in addition to Discord itself being closed, etc.

CurrentUserUpdate(UpdateEvent)

Fired when any details on the current logged in user are changed.

SpeakingStart(SpeakingEvent)

Event fired when a user starts speaking in a lobby voice channel.

SpeakingStop(SpeakingEvent)

Event fired when a user stops speaking in a lobby voice channel.

LobbyMemberConnect(MemberEvent)

Event fired when a user connects to a lobby.

LobbyMemberDisconnect(MemberEvent)

Event fired when a user disconnects from a lobby.

LobbyDelete

Fields

§id: LobbyId

Event fired when a lobby is deleted, or the user disconnects from the lobby.

LobbyUpdate(Lobby)

Event fired when a lobby is updated. Note that this is only the metadata on the lobby itself, not the members.

LobbyMemberUpdate(MemberEvent)

Event fired when the metadata for a lobby member is changed.

LobbyMessage(MessageEvent)

Event fired when a message is sent to the lobby.

LobbyCreate(Lobby)

LobbyConnect(Lobby)

ActivityJoin(SecretEvent)

Sent by Discord when the local user has requested to join a game, and the remote user has accepted their request.

ActivitySpectate(SecretEvent)

Sent by Discord when the local user has chosen to spectate another user’s game session.

ActivityJoinRequest(JoinRequestEvent)

Fires when a user asks to join the current user’s game.

ActivityInvite(InviteEvent)

Fires when the current user is invited by another user to their game.

OverlayUpdate(UpdateEvent)

Event fired when the overlay state changes.

RelationshipUpdate(Arc<Relationship>)

Event fired when a relationship with another user changes.

VoiceSettingsUpdate(VoiceSettingsUpdateEvent)

Event fired when any voice settings are changed

Trait Implementations§

impl Debug for Event

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for Event

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

Auto Trait Implementations§

impl !RefUnwindSafe for Event

impl Send for Event

impl Sync for Event

impl Unpin for Event

impl !UnwindSafe for Event

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> DeserializeOwned for Twhere T: for<'de> Deserialize<'de>,