Enum Invalid 

#[non_exhaustive]
pub enum Invalid {
    PasswordTooShort {
        min: usize,
    },
    PasswordIncorrect,
    EmailRequired,
    LoginOrEmailRequired,
    LoginEmpty,
    LoginsDisabled,
    EmailManagedByGoogle,
    GoogleAccountTaken,
    RoleNotChangeable,
    MalformedRequest,
    Unknown,
}

Available on crate feature alloc only.

Why a request is invalid, the detail of AuthError::Invalid.

On the wire a reason is a stable code with its parameters, such as {"reason":"password_too_short","min":8}, so a frontend can phrase it in its own language. Display gives an English message for the user.

New reasons may be added without a breaking release. One this version does not know, sent by a newer server, decodes as Invalid::Unknown, so an older frontend still shows that the request was refused.

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.

PasswordTooShort

The password is shorter than min bytes; see validate_password.

Fields

min: usize

The shortest password accepted, MIN_PASSWORD_LEN.

PasswordIncorrect

The current password, given to change it, is wrong.

EmailRequired

The app uses only emails, and the user would have none.

LoginOrEmailRequired

The user would have neither a login nor an email.

LoginEmpty

The login name is blank.

LoginsDisabled

A login name was given, but the app uses only emails.

EmailManagedByGoogle

A Google user tried to change their own email, which their Google account manages.

GoogleAccountTaken

The Google account is already linked to another user.

RoleNotChangeable

The role cannot be changed through this route, such as on the user’s own account.

MalformedRequest

The request body could not be read, such as malformed JSON or a missing field.

Unknown

A reason this version does not know, from a newer server; its parameters are dropped. A server never sends it.

New reasons go after it, at the end, since musli numbers variants by position.

Trait Implementations

impl Clone for Invalid

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Invalid

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

Formats the value using the given formatter.

impl<'__de, __A> Decode<'__de, Binary, __A> for Invalid

where __A: Allocator,

Available on crate feature musli02 only.

const IS_BITWISE_DECODE: bool = false

Whether the type is packed. Packed types can be bitwise copied if the representation of the serialization format is identical to the memory layout of the type.

fn decode<T0>(_1: T0) -> Result<Self, <T0 as Decoder<'__de>>::Error>

where T0: Decoder<'__de, Mode = Binary, Allocator = __A>,

Decode the current value.

impl<'__de, __A> Decode<'__de, Text, __A> for Invalid

where __A: Allocator,

Available on crate feature musli02 only.

const IS_BITWISE_DECODE: bool = false

Whether the type is packed. Packed types can be bitwise copied if the representation of the serialization format is identical to the memory layout of the type.

fn decode<T0>(_1: T0) -> Result<Self, <T0 as Decoder<'__de>>::Error>

where T0: Decoder<'__de, Mode = Text, Allocator = __A>,

Decode the current value.

impl<'de> Deserialize<'de> for Invalid

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Invalid

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

Formats the value using the given formatter.

impl Encode<Binary> for Invalid

Available on crate feature musli02 only.

const IS_BITWISE_ENCODE: bool = false

Whether the type is packed. Packed types can be bitwise copied if the representation of the serialization format is identical to the memory layout of the type.

type Encode = Invalid

The underlying type being encoded.

fn encode<T0>(&self, _0: T0) -> Result<(), <T0 as Encoder>::Error>

where T0: Encoder<Mode = Binary>,

Encode the given output.

fn size_hint(&self) -> Option<usize>

The number of fields in the type.

fn as_encode(&self) -> &Self::Encode

Coerce into the underlying value being encoded.

impl Encode<Text> for Invalid

Available on crate feature musli02 only.

const IS_BITWISE_ENCODE: bool = false

Whether the type is packed. Packed types can be bitwise copied if the representation of the serialization format is identical to the memory layout of the type.

type Encode = Invalid

The underlying type being encoded.

fn encode<T0>(&self, _0: T0) -> Result<(), <T0 as Encoder>::Error>

where T0: Encoder<Mode = Text>,

Encode the given output.

fn size_hint(&self) -> Option<usize>

The number of fields in the type.

fn as_encode(&self) -> &Self::Encode

Coerce into the underlying value being encoded.

impl Eq for Invalid

impl Error for Invalid

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 Hash for Invalid

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Invalid

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Invalid

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Invalid