Enum Error

#[non_exhaustive]
pub enum Error {
    HttpError(Error),
    InvalidHeaderValue(InvalidHeaderValue),
    InvalidJson(Error),
    LockFailure(AcquireError),
    IoError(Error),
    TooManyRequests {
        retry_after: Option<u64>,
    },
    BadToken,
    TokenFailure(String),
    NotLoggedIn,
    NotLoggedInAsBot,
    UploadWarning(Vec<String>),
    Maxlag {
        info: String,
        retry_after: Option<u64>,
    },
    Readonly {
        info: String,
        retry_after: Option<u64>,
    },
    InternalException(ApiError),
    ApiError(ApiError),
    Unknown(String),
}

Possible errors

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.

HttpError(Error)

A HTTP error like a 4XX or 5XX status code

InvalidHeaderValue(InvalidHeaderValue)

Invalid header value, likely if the provided OAuth2 token or User-agent are invalid

InvalidJson(Error)

Error when decoding the JSON response from the API

LockFailure(AcquireError)

Error if unable to get request concurrency lock

IoError(Error)

TooManyRequests

A HTTP error with 429 status code

Fields

retry_after: Option<u64>

BadToken

Token invalid or expired

TokenFailure(String)

Unable to fetch a CSRF token

NotLoggedIn

When expected to be logged in but aren’t

NotLoggedInAsBot

When expected to be logged in but aren’t

UploadWarning(Vec<String>)

Maxlag

Fields

info: String

retry_after: Option<u64>

Readonly

When MediaWiki is in readonly mode

Fields

info: String

retry_after: Option<u64>

InternalException(ApiError)

An internal MediaWiki exception

ApiError(ApiError)

Any arbitrary error returned by the MediaWiki API

Unknown(String)

An error where we don’t know what to do nor have information to report back

Implementations

impl Error

pub fn with_retry_after(self, value: u64) -> Self

Store the value of the retry-after header, if one was present, for error types that are safe to retry

pub fn retry_after(&self) -> Option<u64>

If the error merits a retry, how long should we wait?

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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<AcquireError> for Error

fn from(source: AcquireError) -> Self

Converts to this type from the input type.

impl From<ApiError> for Error

fn from(apierr: ApiError) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<InvalidHeaderValue> for Error

fn from(source: InvalidHeaderValue) -> Self

Converts to this type from the input type.