Enum rivet_identity::model::GlobalEventKind
source · [−]#[non_exhaustive]
pub enum GlobalEventKind {
ChatMessage(GlobalEventChatMessage),
ChatRead(GlobalEventChatRead),
MatchmakerLobbyJoin(GlobalEventMatchmakerLobbyJoin),
PartyUpdate(GlobalEventPartyUpdate),
Unknown,
}
Expand description
Kind of event that occured.
Variants (Non-exhaustive)
This enum is marked as non-exhaustive
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.
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.
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
sourceimpl GlobalEventKind
impl GlobalEventKind
sourcepub fn as_chat_message(&self) -> Result<&GlobalEventChatMessage, &Self>
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.
sourcepub fn is_chat_message(&self) -> bool
pub fn is_chat_message(&self) -> bool
Returns true if this is a ChatMessage
.
sourcepub fn as_chat_read(&self) -> Result<&GlobalEventChatRead, &Self>
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.
sourcepub fn is_chat_read(&self) -> bool
pub fn is_chat_read(&self) -> bool
Returns true if this is a ChatRead
.
sourcepub fn as_matchmaker_lobby_join(
&self
) -> Result<&GlobalEventMatchmakerLobbyJoin, &Self>
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.
sourcepub fn is_matchmaker_lobby_join(&self) -> bool
pub fn is_matchmaker_lobby_join(&self) -> bool
Returns true if this is a MatchmakerLobbyJoin
.
sourcepub fn as_party_update(&self) -> Result<&GlobalEventPartyUpdate, &Self>
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.
sourcepub fn is_party_update(&self) -> bool
pub fn is_party_update(&self) -> bool
Returns true if this is a PartyUpdate
.
sourcepub fn is_unknown(&self) -> bool
pub fn is_unknown(&self) -> bool
Returns true if the enum instance is the Unknown
variant.
Trait Implementations
sourceimpl Clone for GlobalEventKind
impl Clone for GlobalEventKind
sourcefn clone(&self) -> GlobalEventKind
fn clone(&self) -> GlobalEventKind
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for GlobalEventKind
impl Debug for GlobalEventKind
sourceimpl PartialEq<GlobalEventKind> for GlobalEventKind
impl PartialEq<GlobalEventKind> for GlobalEventKind
sourcefn eq(&self, other: &GlobalEventKind) -> bool
fn eq(&self, other: &GlobalEventKind) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
impl StructuralPartialEq for GlobalEventKind
Auto Trait Implementations
impl RefUnwindSafe for GlobalEventKind
impl Send for GlobalEventKind
impl Sync for GlobalEventKind
impl Unpin for GlobalEventKind
impl UnwindSafe for GlobalEventKind
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
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
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more