Enum mwbot::Error

#[non_exhaustive]
pub enum Error {
    HttpError(Error),
    InvalidHeaderValue(InvalidHeaderValue),
    JsonError(Error),
    LockError(AcquireError),
    InvalidEtag,
    BadToken,
    TokenError(String),
    InvalidHeadingLevel(u32),
    NotLoggedIn,
    NotLoggedInAsBot,
    PermissionsError(String),
    Blocked {
        info: String,
        details: BlockDetails,
    },
    PartiallyBlocked {
        info: String,
        details: BlockDetails,
    },
    GloballyBlocked(String),
    GloballyRangeBlocked(String),
    GloballyXFFBlocked(String),
    UnknownBlock(String),
    LoginThrottled,
    WrongPassword,
    Nobots,
    PageDoesNotExist(String),
    ProtectedPage,
    EditConflict(String),
    SpamFilter {
        info: String,
        matches: Vec<String, Global>,
    },
    UnknownSaveFailure(Value),
    MaxlagError {
        info: String,
        retry_after: u32,
    },
    Readonly(String),
    InternalError(ApiError),
    ApiError(ApiError),
    UnknownError(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.

HttpError(Error)

Tuple Fields

0: Error

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

InvalidHeaderValue(InvalidHeaderValue)

Tuple Fields

0: InvalidHeaderValue

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

JsonError(Error)

Tuple Fields

0: Error

Error when decoding the JSON response from the API

LockError(AcquireError)

Tuple Fields

0: AcquireError

Error if unable to get request concurrency lock

InvalidEtag

etag header is invalid/missing

BadToken

Token invalid or expired

TokenError(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

PermissionsError(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

Nobots

When {{nobots}} matches

PageDoesNotExist(String)

Tuple Fields

0: String

Page does not exist

ProtectedPage

Page is protected

EditConflict(String)

Tuple Fields

0: String

Edit conflict

SpamFilter

Fields

info: String

matches: Vec<String, Global>

Tripped the spam filter (aka SpamBlacklist)

UnknownSaveFailure(Value)

Tuple Fields

0: Value

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

MaxlagError

Fields

info: String

retry_after: u32

Readonly(String)

Tuple Fields

0: String

When MediaWiki is in readonly mode

InternalError(ApiError)

Tuple Fields

0: ApiError

An internal MediaWiki exception

ApiError(ApiError)

Tuple Fields

0: ApiError

Any arbitrary error returned by the MediaWiki API

UnknownError(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_save_error(&self) -> bool

Whether the issue is related to saving a page

pub fn is_block_error(&self) -> bool

Whether the issue is related to a 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 Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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

pub fn from(source: AcquireError) -> Error

Performs the conversion.

impl From<ApiError> for Error

pub fn from(apierr: ApiError) -> Error

Performs the conversion.

impl From<Error> for Error

pub fn from(source: Error) -> Error

Performs the conversion.

impl From<Error> for Error

pub fn from(source: Error) -> Error

Performs the conversion.

impl From<Error> for ConfigError

fn from(source: Error) -> Self

Performs the conversion.

impl From<InvalidHeaderValue> for Error

pub fn from(source: InvalidHeaderValue) -> Error

Performs the conversion.