Enum AuthError 

#[non_exhaustive]
pub enum AuthError {
    TokenExpired,
    SessionExpired,
    InvalidAuth,
    UnexpectedAuth,
    MissingUserOrPass,
    NoSigninTarget,
    InvalidPass,
    TokenMakingFailed,
    InvalidSignup,
    InvalidRole {
        name: String,
    },
    NotAllowed {
        actor: String,
        action: String,
        resource: String,
    },
}

Auth failure reason for [ErrorKind::NotAllowed] errors.

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.

TokenExpired

The token used for authentication has expired.

SessionExpired

The session has expired.

InvalidAuth

Authentication failed (invalid credentials or similar).

UnexpectedAuth

Unexpected error while performing authentication.

MissingUserOrPass

Username or password was not provided.

NoSigninTarget

No signin target (SC, DB, NS, or KV) specified.

InvalidPass

The password did not verify.

TokenMakingFailed

Failed to create the authentication token.

InvalidSignup

Signup failed.

InvalidRole

Invalid role (IAM). Carries the role name.

Fields

name: String

Name of the invalid role.

NotAllowed

Not enough permissions to perform the action (IAM). Carries actor, action, resource.

Fields

actor: String

Actor that attempted the action.

action: String

Action that was attempted.

resource: String

Resource the action was attempted on.

Trait Implementations

impl Clone for AuthError

fn clone(&self) -> AuthError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthError

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

Formats the value using the given formatter.

impl From<AuthError> for Option<NotAllowedError>

fn from(auth_error: AuthError) -> Self

Converts to this type from the input type.

impl PartialEq for AuthError

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl SurrealValue for AuthError

fn into_value(self) -> Value

Converts this type into a SurrealDB value

fn from_value(value: Value) -> Result<Self, Error>

Attempts to convert a SurrealDB value into this type

fn is_value(value: &Value) -> bool

Checks if the given value can be converted to this type

fn kind_of() -> Kind

Returns the kind that represents this type

impl Eq for AuthError

impl StructuralPartialEq for AuthError