Enum MfaError 

pub enum MfaError {
    ChallengeExpired,
    InvalidCode,
    MethodNotSupported {
        method: String,
    },
    SetupRequired,
    VerificationFailed {
        message: String,
    },
}

Multi-factor authentication errors.

Variants

ChallengeExpired

The MFA challenge window has elapsed; the user must request a new challenge.

InvalidCode

The TOTP or one-time code provided by the user is incorrect.

MethodNotSupported

The requested MFA method (e.g. SMS, hardware key) is not enabled.

Fields

method: String

SetupRequired

MFA has not been configured for this account yet.

VerificationFailed

MFA verification failed for a reason described in message.

Fields

message: String

Implementations

impl MfaError

pub fn method_not_supported(method: impl Into<String>) -> Self

Create a new method not supported error.

Example

use auth_framework::errors::MfaError;

let err = MfaError::method_not_supported("biometric");
assert!(err.to_string().contains("biometric"));

pub fn verification_failed(message: impl Into<String>) -> Self

Create a new verification failed error.

Example

use auth_framework::errors::MfaError;

let err = MfaError::verification_failed("code expired");
assert!(err.to_string().contains("code expired"));

Trait Implementations

impl Debug for MfaError

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

Formats the value using the given formatter.

impl Display for MfaError

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

Formats the value using the given formatter.

impl Error for MfaError

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<MfaError> for AuthError

fn from(source: MfaError) -> Self

Converts to this type from the input type.