Enum GlobalEventKind 

#[non_exhaustive]
pub enum GlobalEventKind {
    ChatMessage(GlobalEventChatMessage),
    ChatRead(GlobalEventChatRead),
    ChatThreadRemove(GlobalEventChatThreadRemove),
    IdentityUpdate(GlobalEventIdentityUpdate),
    MatchmakerLobbyJoin(GlobalEventMatchmakerLobbyJoin),
    PartyUpdate(GlobalEventPartyUpdate),
    #[non_exhaustive]
    Unknown,
}

Kind of event that occured.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

ChatMessage(GlobalEventChatMessage)

rivet.api.identity.common#GlobalEventKind variant for chat messages. Received any time a message is sent to a chat the identity is in.

ChatRead(GlobalEventChatRead)

rivet.api.identity.common#GlobalEventKind variant for chat reads. Received any time the last read timestamp is set. Used to update the status of unread indicators on chats.

ChatThreadRemove(GlobalEventChatThreadRemove)

rivet.api.identity.common#GlobalEventKind variant for a chat thread being removed. Received any time the current identity is no longer able to access the given thread. This can happen if

IdentityUpdate(GlobalEventIdentityUpdate)

rivet.api.identity.common#GlobalEventKind variant for identity updates. Received any time identity details are changed OR the identity switches.

MatchmakerLobbyJoin(GlobalEventMatchmakerLobbyJoin)

rivet.api.identity.common#GlobalEventKind variant for party updates. Received when the identity should be instructed to join a lobby. This needs to be implemented in conjunction with parties in order to force clients to join the same lobby as the party they’re in.

PartyUpdate(GlobalEventPartyUpdate)

rivet.api.identity.common#GlobalEventKind variant for party updates. Received any time the identity joins a party, a party is updated, or when the identity leaves a party.

#[non_exhaustive]

Unknown

The Unknown variant represents cases where new union variant was received. Consider upgrading the SDK to the latest available version. An unknown enum variant

Note: If you encounter this error, consider upgrading your SDK to the latest version. The Unknown variant represents cases where the server sent a value that wasn’t recognized by the client. This can happen when the server adds new functionality, but the client has not been updated. To investigate this, consider turning on debug logging to print the raw HTTP response.

Implementations

impl GlobalEventKind

pub fn as_chat_message(&self) -> Result<&GlobalEventChatMessage, &Self>

Tries to convert the enum instance into ChatMessage, extracting the inner GlobalEventChatMessage. Returns Err(&Self) if it can’t be converted.

pub fn is_chat_message(&self) -> bool

Returns true if this is a ChatMessage.

pub fn as_chat_read(&self) -> Result<&GlobalEventChatRead, &Self>

Tries to convert the enum instance into ChatRead, extracting the inner GlobalEventChatRead. Returns Err(&Self) if it can’t be converted.

pub fn is_chat_read(&self) -> bool

Returns true if this is a ChatRead.

pub fn as_chat_thread_remove( &self, ) -> Result<&GlobalEventChatThreadRemove, &Self>

Tries to convert the enum instance into ChatThreadRemove, extracting the inner GlobalEventChatThreadRemove. Returns Err(&Self) if it can’t be converted.

pub fn is_chat_thread_remove(&self) -> bool

Returns true if this is a ChatThreadRemove.

pub fn as_identity_update(&self) -> Result<&GlobalEventIdentityUpdate, &Self>

Tries to convert the enum instance into IdentityUpdate, extracting the inner GlobalEventIdentityUpdate. Returns Err(&Self) if it can’t be converted.

pub fn is_identity_update(&self) -> bool

Returns true if this is a IdentityUpdate.

pub fn as_matchmaker_lobby_join( &self, ) -> Result<&GlobalEventMatchmakerLobbyJoin, &Self>

Tries to convert the enum instance into MatchmakerLobbyJoin, extracting the inner GlobalEventMatchmakerLobbyJoin. Returns Err(&Self) if it can’t be converted.

pub fn is_matchmaker_lobby_join(&self) -> bool

Returns true if this is a MatchmakerLobbyJoin.

pub fn as_party_update(&self) -> Result<&GlobalEventPartyUpdate, &Self>

Tries to convert the enum instance into PartyUpdate, extracting the inner GlobalEventPartyUpdate. Returns Err(&Self) if it can’t be converted.

pub fn is_party_update(&self) -> bool

Returns true if this is a PartyUpdate.

pub fn is_unknown(&self) -> bool

Returns true if the enum instance is the Unknown variant.

Trait Implementations

impl Clone for GlobalEventKind

fn clone(&self) -> GlobalEventKind

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GlobalEventKind

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

Formats the value using the given formatter.

impl PartialEq for GlobalEventKind

fn eq(&self, other: &GlobalEventKind) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GlobalEventKind