Enum mwapi_errors::Error

#[non_exhaustive]
pub enum Error {
    InvalidJson(Arc<Error>),
    InvalidEtag,
    BadToken,
    TokenFailure(String),
    InvalidHeadingLevel(u32),
    NotLoggedIn,
    NotLoggedInAsBot,
    PermissionDenied(String),
    Blocked {
        info: String,
        details: BlockDetails,
    },
    PartiallyBlocked {
        info: String,
        details: BlockDetails,
    },
    GloballyBlocked(String),
    GloballyRangeBlocked(String),
    GloballyXFFBlocked(String),
    UnknownBlock(String),
    LoginThrottled,
    WrongPassword,
    InvalidPage,
    Nobots,
    PageDoesNotExist(String),
    ProtectedPage,
    EditConflict,
    ContentTooBig(String),
    SpamFilter {
        info: String,
        matches: Vec<String>,
    },
    UnknownSaveFailure(Value),
    Maxlag(String),
    Readonly(String),
    InternalException(ApiError),
    ApiError(ApiError),
    Unknown(String),
}

Primary error class

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.

InvalidJson(Arc<Error>)

Tuple Fields

0: Arc<Error>

Error when decoding the JSON response from the API

InvalidEtag

etag header is invalid/missing

BadToken

Token invalid or expired

TokenFailure(String)

Tuple Fields

0: String

Unable to fetch a CSRF token

InvalidHeadingLevel(u32)

Tuple Fields

0: u32

NotLoggedIn

When expected to be logged in but aren’t

NotLoggedInAsBot

When expected to be logged in but aren’t

PermissionDenied(String)

Tuple Fields

0: String

Blocked

Fields

info: String

details: BlockDetails

PartiallyBlocked

Fields

info: String

details: BlockDetails

GloballyBlocked(String)

Tuple Fields

0: String

GloballyRangeBlocked(String)

Tuple Fields

0: String

GloballyXFFBlocked(String)

Tuple Fields

0: String

UnknownBlock(String)

Tuple Fields

0: String

When we can’t group it into a more specific block

LoginThrottled

WrongPassword

InvalidPage

Nobots

When {{nobots}} matches

PageDoesNotExist(String)

Tuple Fields

0: String

Page does not exist

ProtectedPage

Page is protected

EditConflict

Edit conflict

ContentTooBig(String)

Tuple Fields

0: String

SpamFilter

Fields

info: String

matches: Vec<String>

Tripped the spam filter (aka SpamBlacklist)

UnknownSaveFailure(Value)

Tuple Fields

0: Value

Some save failure happened, but we don’t know what it is

Maxlag(String)

Tuple Fields

0: String

Readonly(String)

Tuple Fields

0: String

When MediaWiki is in readonly mode

InternalException(ApiError)

Tuple Fields

0: ApiError

An internal MediaWiki exception

ApiError(ApiError)

Tuple Fields

0: ApiError

Any arbitrary error returned by the MediaWiki API

Unknown(String)

Tuple Fields

0: String

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

Implementations

impl Error

pub fn is_page_related(&self) -> bool

Whether the issue is related to a specific page rather than a global issue

pub fn is_sitewide_block(&self) -> bool

Whether the issue is related to a sitewide block

pub fn should_retry(&self) -> bool

Whether the request should be retried, after some suitable backoff and likely with some retry limit

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a copy of the value.

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

Performs copy-assignment from source.

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)>

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 From<ApiError> for Error

fn from(apierr: ApiError) -> Self

Performs the conversion.

impl From<Error> for Error

fn from(err: Error) -> Self

Performs the conversion.