Enum ggrs::GGRSError

pub enum GGRSError {
    GeneralFailure,
    InvalidHandle,
    PredictionThreshold,
    InvalidRequest,
    MismatchedChecksum {
        frame: Frame,
    },
    SocketCreationFailed,
    NotSynchronized,
    PlayerDisconnected,
    SpectatorTooFarBehind,
}

This enum contains all error messages this library can return. Most API functions will generally return a Result<(),GGRSError>.

Variants

GeneralFailure

A catch-all error if something breaks horribly.

InvalidHandle

The given player handle was invalid. Usually this indicates you passed a player handle >= num_players.

PredictionThreshold

When the prediction threshold has been reached, we cannot accept more inputs from the local player.

InvalidRequest

You made an invalid request, usually by using wrong parameters for function calls or starting a session that is already started.

MismatchedChecksum

In a SyncTestSession, this error is returned if checksums of resimulated frames do not match up with the original checksum.

Fields of MismatchedChecksum

frame: Frame

SocketCreationFailed

A problem occured during creation of the UDP socket.

NotSynchronized

The Session is not synchronized yet. Please start the session and wait a few ms to let the clients synchronize.

PlayerDisconnected

The player you are trying to disconnect is already disconnected.

SpectatorTooFarBehind

The spectator got so far behind the host that catching up is impossible.

Trait Implementations

impl Clone for GGRSError

fn clone(&self) -> GGRSError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GGRSError

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

Formats the value using the given formatter.

impl Display for GGRSError

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

Formats the value using the given formatter.

impl Error for GGRSError

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred.

fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl Hash for GGRSError

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<GGRSError> for GGRSError

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for GGRSError