Skip to main content

ServerMessage

Enum ServerMessage 

Source
pub enum ServerMessage {
Show 24 variants Authenticated { app_name: String, organization: Option<String>, rate_limits: RateLimitInfo, }, ProtocolInfo(ProtocolInfoPayload), AuthenticationError { error: String, error_code: ErrorCode, }, RoomJoined(Box<RoomJoinedPayload>), RoomJoinFailed { reason: String, error_code: Option<ErrorCode>, }, RoomLeft, PlayerJoined { player: PlayerInfo, }, PlayerLeft { player_id: PlayerId, }, GameData { from_player: PlayerId, data: Value, }, GameDataBinary { from_player: PlayerId, encoding: GameDataEncoding, payload: Vec<u8>, }, AuthorityChanged { authority_player: Option<PlayerId>, you_are_authority: bool, }, AuthorityResponse { granted: bool, reason: Option<String>, error_code: Option<ErrorCode>, }, LobbyStateChanged { lobby_state: LobbyState, ready_players: Vec<PlayerId>, all_ready: bool, }, GameStarting { peer_connections: Vec<PeerConnectionInfo>, }, Pong, Reconnected(Box<ReconnectedPayload>), ReconnectionFailed { reason: String, error_code: ErrorCode, }, PlayerReconnected { player_id: PlayerId, }, SpectatorJoined(Box<SpectatorJoinedPayload>), SpectatorJoinFailed { reason: String, error_code: Option<ErrorCode>, }, SpectatorLeft { room_id: Option<RoomId>, room_code: Option<String>, reason: Option<SpectatorStateChangeReason>, current_spectators: Vec<SpectatorInfo>, }, NewSpectatorJoined { spectator: SpectatorInfo, current_spectators: Vec<SpectatorInfo>, reason: Option<SpectatorStateChangeReason>, }, SpectatorDisconnected { spectator_id: PlayerId, reason: Option<SpectatorStateChangeReason>, current_spectators: Vec<SpectatorInfo>, }, Error { message: String, error_code: Option<ErrorCode>, },
}
Expand description

Message types sent from server to client.

Variants§

§

Authenticated

Authentication successful.

Fields

§app_name: String

App name for confirmation.

§organization: Option<String>

Organization name (if any).

§rate_limits: RateLimitInfo

Rate limits for this app.

§

ProtocolInfo(ProtocolInfoPayload)

SDK/protocol compatibility details advertised after authentication.

§

AuthenticationError

Authentication failed.

Fields

§error: String

Error message.

§error_code: ErrorCode

Error code for programmatic handling.

§

RoomJoined(Box<RoomJoinedPayload>)

Successfully joined a room (boxed to reduce enum size).

§

RoomJoinFailed

Failed to join room.

Fields

§reason: String
§error_code: Option<ErrorCode>
§

RoomLeft

Successfully left room.

§

PlayerJoined

Another player joined the room.

Fields

§player: PlayerInfo
§

PlayerLeft

Another player left the room.

Fields

§player_id: PlayerId
§

GameData

Game data from another player.

Fields

§from_player: PlayerId
§data: Value
§

GameDataBinary

Binary game data payload from another player. Uses Vec<u8> with serde_bytes for efficient serialization.

Fields

§from_player: PlayerId
§payload: Vec<u8>
§

AuthorityChanged

Authority status changed.

Fields

§authority_player: Option<PlayerId>
§you_are_authority: bool
§

AuthorityResponse

Authority request response.

Fields

§granted: bool
§reason: Option<String>
§error_code: Option<ErrorCode>
§

LobbyStateChanged

Lobby state changed (room full, player readiness changed, etc.).

Fields

§lobby_state: LobbyState
§ready_players: Vec<PlayerId>
§all_ready: bool
§

GameStarting

Game is starting with peer connection information.

Fields

§peer_connections: Vec<PeerConnectionInfo>
§

Pong

Pong response to ping.

§

Reconnected(Box<ReconnectedPayload>)

Reconnection successful (boxed to reduce enum size).

§

ReconnectionFailed

Reconnection failed.

Fields

§reason: String
§error_code: ErrorCode
§

PlayerReconnected

Another player reconnected to the room.

Fields

§player_id: PlayerId
§

SpectatorJoined(Box<SpectatorJoinedPayload>)

Successfully joined a room as spectator (boxed to reduce enum size).

§

SpectatorJoinFailed

Failed to join as spectator.

Fields

§reason: String
§error_code: Option<ErrorCode>
§

SpectatorLeft

Successfully left spectator mode.

Fields

§room_id: Option<RoomId>
§room_code: Option<String>
§current_spectators: Vec<SpectatorInfo>
§

NewSpectatorJoined

Another spectator joined the room.

Fields

§spectator: SpectatorInfo
§current_spectators: Vec<SpectatorInfo>
§

SpectatorDisconnected

Another spectator left the room.

Fields

§spectator_id: PlayerId
§current_spectators: Vec<SpectatorInfo>
§

Error

Error message.

Fields

§message: String
§error_code: Option<ErrorCode>

Trait Implementations§

Source§

impl Clone for ServerMessage

Source§

fn clone(&self) -> ServerMessage

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ServerMessage

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ServerMessage

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl From<ServerMessage> for SignalFishEvent

Source§

fn from(msg: ServerMessage) -> Self

Converts to this type from the input type.
Source§

impl Serialize for ServerMessage

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

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.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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