Enum RoboatError 

#[non_exhaustive]
pub enum RoboatError {
    TooManyRequests,
    InternalServerError,
    BadRequest,
    InvalidRoblosecurity,
    UnknownRobloxErrorCode {
        code: u16,
        message: String,
    },
    RoblosecurityNotSet,
    UnidentifiedStatusCode(u16),
    MalformedResponse,
    InvalidXcsrf(String),
    XcsrfNotReturned,
    ChallengeRequired(String),
    UnknownStatus403Format,
    PurchaseTradableLimitedError(PurchaseTradableLimitedError),
    PurchaseNonTradableLimitedError(PurchaseNonTradableLimitedError),
    ReqwestError(Error),
    IoError(Error),
    InvalidPath(String),
}

The universal error used in this crate. Encapsulates any sub-errors used in this crate.

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.

TooManyRequests

Used when an endpoint returns status code 429.

InternalServerError

Used when an endpoint returns status code 500.

BadRequest

Used when an endpoint returns status code 400 and does not embed an error. This is used when the server cannot process the data sent, whether it be because it is in the wrong format or it contains too much data.

InvalidRoblosecurity

Returned when the user does not have a valid roblosecurity, or does not have authorization to access the endpoint.

This is also used as the backup error when an endpoint returns a 401 status code but the error cannot be parsed from the response.

Roblox error code 0.

UnknownRobloxErrorCode

Returned when the endpoint returns a 401 status code, but the error response contains an unknown Roblox error code.

Fields

code: u16

The error code (not status code) returned by roblox.

message: String

The error message returned by roblox.

RoblosecurityNotSet

Used when no roblosecurity is set, on an endpoint that requires it.

UnidentifiedStatusCode(u16)

Used for any status codes that do not fit any enum variants of this error. If you encounter this enum variant, please submit an issue so a variant can be made or the crate can be fixed.

MalformedResponse

Used when the response from an API endpoint is malformed.

InvalidXcsrf(String)

Used when an endpoint rejects a request due to an invalid xcsrf. Mostly used internally invalid xcsrf is returned due to the fact that rust does not allow async recursion without making a type signature extremely messy.

XcsrfNotReturned

Used when an endpoint returns a 403 status code, doesn’t need a challenge, but the response does not contain a new xcsrf.

ChallengeRequired(String)

Used when an endpoint returns a 403 status code, but not because of an invalid xcsrf. The string inside this error variant is a challenge id, which can be used to complete the challenge (which can be either a captcha or a two step verification code).

UnknownStatus403Format

Used when an endpoint returns a 403 status code, can be parsed into a roblox error, but the error message is incorrect or the challenge id is not returned. This also means that no xcsrf was returned.

PurchaseTradableLimitedError(PurchaseTradableLimitedError)

Custom Roblox errors sometimes thrown when the user calls Client::purchase_tradable_limited.

PurchaseNonTradableLimitedError(PurchaseNonTradableLimitedError)

Custom Roblox errors sometimes thrown when the user calls Client::purchase_non_tradable_limited.

ReqwestError(Error)

Used for any reqwest error that occurs.

IoError(Error)

Used when an io error occurs.

InvalidPath(String)

Used when a file system path passed to a method is invalid.

Trait Implementations

impl Debug for RoboatError

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

Formats the value using the given formatter.

impl Default for RoboatError

fn default() -> RoboatError

Returns the “default value” for a type.

impl Display for RoboatError

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

Formats the value using the given formatter.

impl Error for RoboatError

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

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

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

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.

impl From<Error> for RoboatError

fn from(source: Error) -> Self

Converts to this type from the input type.