Enum SFError

#[non_exhaustive]
pub enum SFError {
    InvalidRequest(&'static str),
    EmptyResponse,
    ConnectionError,
    ParsingError(&'static str, String),
    ServerError(String),
    UnsupportedVersion(u32),
    TooShortResponse {
        name: &'static str,
        pos: usize,
        array: String,
    },
}

An error, that occurred during the communication (sending/receiving/parsing) of requests to the S&F server

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

InvalidRequest(&'static str)

Whatever you were trying to send was not possible to send. This is either our issue when you were doing something normal, or you were sending invalid stuff, like a SSO login on a normal logged in character

EmptyResponse

The server replied with an empty response. This could have a range of reasons. Could be a bad request, not logged in, or something else

ConnectionError

There was some error encountered when sending data to the server. Most likely the server, or your connection is down

ParsingError(&'static str, String)

Whatever the server send back was invalid. Could be because of features not yet supported, or a bug in the API

ServerError(String)

The server responded with an error. If you are already logged in, this is likely recoverable, i.e you are able to reuse your session. You should just not resend the same command, as the server had some error with it. Most likely that you were not allowed to do your action (spend money you don’t have, etc.)

UnsupportedVersion(u32)

The server version is newer, than the limit set in the server communication

TooShortResponse

The server responded with a response, that was too short

Fields

name: &'static str

The name of the item, that was accessed

pos: usize

The position at which the array access failed

array: String

The full array in debug print

Trait Implementations

impl Debug for SFError

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

Formats the value using the given formatter.

impl Display for SFError

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

Formats the value using the given formatter.

impl Error for SFError

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

Returns the lower-level source of this error, if any.

fn description(&self) -> &'static 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

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.