Struct ErrorSchema 

pub struct ErrorSchema {
    pub error: Option<String>,
    pub error_description: Option<String>,
    pub code: Option<i32>,
    pub msg: Option<String>,
    pub weak_password: Option<WeakPassword>,
}

Error response schema.

Fields

error: Option<String>

Certain responses will contain this property with the provided values.

Usually one of these:

• invalid_request
• unauthorized_client
• access_denied
• server_error
• temporarily_unavailable
• unsupported_otp_type

error_description: Option<String>

Certain responses that have an error property may have this property which describes the error.

code: Option<i32>

The HTTP status code. Usually missing if error is present.

msg: Option<String>

A basic message describing the problem with the request. Usually missing if error is present.

weak_password: Option<WeakPassword>

Only returned on the /signup endpoint if the password used is too weak. Inspect the reasons and msg property to identify the causes.

Implementations

impl ErrorSchema

pub fn builder() -> ErrorSchemaBuilder<((), (), (), (), ())>

Create a builder for building ErrorSchema. On the builder, call .error(...)(optional), .error_description(...)(optional), .code(...)(optional), .msg(...)(optional), .weak_password(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of ErrorSchema.

Trait Implementations

impl Clone for ErrorSchema

fn clone(&self) -> ErrorSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ErrorSchema

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ErrorSchema

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ErrorSchema

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

Formats the value using the given formatter.

impl Error for ErrorSchema

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<ErrorSchema> for RefreshStreamError

fn from(source: ErrorSchema) -> Self

Converts to this type from the input type.

impl Serialize for ErrorSchema

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.