Enum ggrs::GGRSError

source · [−]

pub enum GGRSError {
    PredictionThreshold,
    InvalidRequest {
        info: String,
    },
    MismatchedChecksum {
        frame: Frame,
    },
    NotSynchronized,
    SpectatorTooFarBehind,
    SocketCreationFailed,
    PlayerDisconnected,
    DecodingError,
}

Expand description

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

Variants

`PredictionThreshold`

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

`InvalidRequest`

Fields

info: String

Further specifies why the request was invalid.

You made an invalid request, usually by using wrong parameters for function calls.

`MismatchedChecksum`

Fields

frame: Frame

The frame at which the mismatch occurred.

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

`NotSynchronized`

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

`SpectatorTooFarBehind`

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

`SocketCreationFailed`

Deprecated, will be removed in next major release

`PlayerDisconnected`

Deprecated, will be removed in next major release

`DecodingError`

Deprecated, will be removed in next major release

Trait Implementations

impl Clone for GGRSError

fn clone(&self) -> GGRSError

Returns a copy 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 GGRSError

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

Formats the value using the given formatter. Read more

impl Display for GGRSError

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

Formats the value using the given formatter. Read more

impl Error for GGRSError

1.30.0 · source

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

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

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

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

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

1.0.0 · source

fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · source

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. Read more

1.3.0 · source

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

Feeds a slice of this type into the given Hasher. Read more

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 ==. Read more

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

This method tests for !=.

impl StructuralPartialEq for GGRSError

Auto Trait Implementations

impl RefUnwindSafe for GGRSError

impl Send for GGRSError

impl Sync for GGRSError

impl Unpin for GGRSError

impl UnwindSafe for GGRSError

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> AsFail for T where
T: Fail,

pub fn as_fail(&self) -> &(dyn Fail + 'static)

Converts a reference to Self into a dynamic trait object of Fail.

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<E> Fail for E where
E: 'static + Error + Send + Sync,

fn name(&self) -> Option<&str>

Returns the “name” of the error. Read more

fn cause(&self) -> Option<&(dyn Fail + 'static)>

Returns a reference to the underlying cause of this failure, if it is an error that wraps other errors. Read more

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

Returns a reference to the Backtrace carried by this failure, if it carries one. Read more

fn context<D>(self, context: D) -> Context<D> where
D: 'static + Display + Send + Sync,

Provides context for this failure. Read more

fn compat(self) -> Compat<Self>

Wraps this failure in a compatibility wrapper that implements std::error::Error. Read more

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

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

const: unstable · source

pub 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> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T

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

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

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

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

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

pub default 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.

const: unstable · source

pub 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.

const: unstable · source

pub 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>,

pub fn vzip(self) -> V