Skip to main content

ErrorCode

signal_fish_client::error_codes

Enum ErrorCode

pub enum ErrorCode {
Show 40 variants    Unauthorized,
    InvalidToken,
    AuthenticationRequired,
    InvalidAppId,
    AppIdExpired,
    AppIdRevoked,
    AppIdSuspended,
    MissingAppId,
    AuthenticationTimeout,
    SdkVersionUnsupported,
    UnsupportedGameDataFormat,
    InvalidInput,
    InvalidGameName,
    InvalidRoomCode,
    InvalidPlayerName,
    InvalidMaxPlayers,
    MessageTooLarge,
    RoomNotFound,
    RoomFull,
    AlreadyInRoom,
    NotInRoom,
    RoomCreationFailed,
    MaxRoomsPerGameExceeded,
    InvalidRoomState,
    AuthorityNotSupported,
    AuthorityConflict,
    AuthorityDenied,
    RateLimitExceeded,
    TooManyConnections,
    ReconnectionFailed,
    ReconnectionTokenInvalid,
    ReconnectionExpired,
    PlayerAlreadyConnected,
    SpectatorNotAllowed,
    TooManySpectators,
    NotASpectator,
    SpectatorJoinFailed,
    InternalError,
    StorageError,
    ServiceUnavailable,
}

Expand description

Structured error codes returned by the Signal Fish server.

Each variant corresponds to a specific error condition. The server sends these as "SCREAMING_SNAKE_CASE" strings (e.g., "ROOM_NOT_FOUND").

Use description() for a human-readable explanation.

Variants§

Unauthorized

InvalidToken

AuthenticationRequired

InvalidAppId

AppIdExpired

AppIdRevoked

AppIdSuspended

MissingAppId

AuthenticationTimeout

SdkVersionUnsupported

UnsupportedGameDataFormat

InvalidInput

InvalidGameName

InvalidRoomCode

InvalidPlayerName

InvalidMaxPlayers

MessageTooLarge

RoomNotFound

RoomFull

AlreadyInRoom

NotInRoom

RoomCreationFailed

MaxRoomsPerGameExceeded

InvalidRoomState

AuthorityNotSupported

AuthorityConflict

AuthorityDenied

RateLimitExceeded

TooManyConnections

ReconnectionFailed

ReconnectionTokenInvalid

ReconnectionExpired

PlayerAlreadyConnected

SpectatorNotAllowed

TooManySpectators

NotASpectator

SpectatorJoinFailed

InternalError

StorageError

ServiceUnavailable

Implementations§

impl ErrorCode

pub fn description(&self) -> &'static str

Returns a human-readable description of this error code.

This method provides actionable error messages that SDK developers can display to end users or use for debugging.

Trait Implementations§

impl Clone for ErrorCode

fn clone(&self) -> ErrorCode

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

impl Debug for ErrorCode

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for ErrorCode

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

Deserialize this value from the given Serde deserializer. Read more

impl Display for ErrorCode

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

Formats the value using the given formatter. Read more

impl PartialEq for ErrorCode

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

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

1.0.0 · Source§

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 Serialize for ErrorCode

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

Serialize this value into the given Serde serializer. Read more

impl Eq for ErrorCode

impl StructuralPartialEq for ErrorCode

Auto Trait Implementations§

impl Freeze for ErrorCode

impl RefUnwindSafe for ErrorCode

impl Send for ErrorCode

impl Sync for ErrorCode

impl Unpin for ErrorCode

impl UnsafeUnpin for ErrorCode

impl UnwindSafe for ErrorCode

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

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 T
where U: From<T>,

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> Same for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

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

fn vzip(self) -> V

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 T
where T: for<'de> Deserialize<'de>,