Enum AuthenticationError

#[non_exhaustive]
pub enum AuthenticationError {
    AccessTokenNotValid,
    UnsupportedChallenge(String),
    LoginFailed(SdkError<InitiateAuthError>),
    ChallengeFailed(SdkError<RespondToAuthChallengeError>),
    MissingChallengeParameter(String),
    SrpFailed(SrpError),
    NextChallenge(ChallengeRequest),
    DeviceConfirmationError(DeviceConfirmationError),
    AuthenticationRefreshFailed,
    NoAuthenticationInProgress,
    NotLoggedIn,
    DeviceAlreadyTrusted,
}

Errors that can occur while trying to communicate with the Hive Authentication servers.

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.

AccessTokenNotValid

No Access Token was issued in the response from the Hive authentication servers.

UnsupportedChallenge(String)

The challenge presented by the Hive authentication servers is not supported by this crate.

LoginFailed(SdkError<InitiateAuthError>)

The request to begin the authentication flow failed.

ChallengeFailed(SdkError<RespondToAuthChallengeError>)

The request to respond to a challenge during the authentication flow failed.

MissingChallengeParameter(String)

A parameter which was expected to be present in the challenge was not found.

SrpFailed(SrpError)

An error occured while trying to complete the Secure Remote Password (SRP) authentication challenges.

NextChallenge(ChallengeRequest)

A challenge was requested by the Hive authentication servers which requires manual intervention.

For example, a SMS MFA code was sent to the user’s phone number.

DeviceConfirmationError(DeviceConfirmationError)

The request to confirm the device (to make it a crate::authentication::TrustedDevice) failed.

AuthenticationRefreshFailed

The request to refresh the authentication tokens failed.

NoAuthenticationInProgress

There is no authentication flow currently in progress, and the user is not logged in.

NotLoggedIn

No authentication flow has been started.

DeviceAlreadyTrusted

The device being confirmed is already trusted, meaning no confirmation is needed.

Trait Implementations

impl Debug for AuthenticationError

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

Formats the value using the given formatter.

impl Display for AuthenticationError

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

Formats the value using the given formatter.

impl Error for AuthenticationError

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<DeviceConfirmationError> for AuthenticationError

fn from(source: DeviceConfirmationError) -> Self

Converts to this type from the input type.

impl From<SdkError<InitiateAuthError, Response>> for AuthenticationError

fn from(source: SdkError<InitiateAuthError>) -> Self

Converts to this type from the input type.

impl From<SdkError<RespondToAuthChallengeError, Response>> for AuthenticationError

fn from(source: SdkError<RespondToAuthChallengeError>) -> Self

Converts to this type from the input type.

impl From<SrpError> for AuthenticationError

fn from(source: SrpError) -> Self

Converts to this type from the input type.