Struct types::error::schema::MangaDexError

pub struct MangaDexError {
    pub id: Uuid,
    pub status: u16,
    pub title: Option<String>,
    pub detail: Option<String>,
    pub context: Option<HashMap<String, String>>,
}

Fields

id: Uuid

status: u16

HTTP status code.

title: Option<String>

Error title.

detail: Option<String>

Description about the error.

context: Option<HashMap<String, String>>

Provides insight into why the request failed.

Captcha Errors (400)

The error may have been caused by one of the following:

• Captcha challenge result was wrong.
• The Captcha Verification service was down.
• Other, refer to the error message and the errorCode value.

Rate Limit, Captcha Required (403)

Some endpoints may require captchas to proceed, in order to slow down automated malicious traffic. Legitimate users might also be affected, based on the frequency of write requests or due certain endpoints being particularly sensitive to malicious use, such as user signup.

Once an endpoint decides that a captcha needs to be solved, a 403 Forbidden response will be returned, with the error code captcha_required_exception. The sitekey needed for recaptcha to function is provided in both the X-Captcha-Sitekey header field, as well as in the error context, specified as siteKey parameter.

The captcha result of the client can either be passed into the repeated original request with the X-Captcha-Result header or alternatively to the POST /captcha/solve endpoint. The time a solved captcha is remembered varies across different endpoints and can also be influenced by individual client behavior.

Authentication is not required for the POST /captcha/solve endpoint, captchas are tracked both by client ip and logged in user id. If you are logged in, you want to send the session token along, so you validate the captcha for your client ip and user id at the same time, but it is not required.

Trait Implementations

impl Clone for MangaDexError

fn clone(&self) -> MangaDexError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MangaDexError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MangaDexError

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for MangaDexError

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

Formats the value using the given formatter.

impl Error for MangaDexError

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 PartialEq<MangaDexError> for MangaDexError

fn eq(&self, other: &MangaDexError) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &MangaDexError) -> bool

This method tests for !=.

impl Eq for MangaDexError

impl StructuralEq for MangaDexError

impl StructuralPartialEq for MangaDexError