Enum AuthenticationError

#[non_exhaustive]
pub enum AuthenticationError {
    InvalidCredentials,
    MfaCodeRequired,
    OAuthError(Error),
    InvalidResponse(Error),
    UnsupportedChallenge(String),
    SessionFailed,
}

Errors which can occur when trying to authenticate with the Ring API.

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.

InvalidCredentials

The credentials provided were invalid.

MfaCodeRequired

Ring presented a MFA (Two Factor Authentication) challenge which require an SMS code to be sent to the user, and provided to the API.

This typically occurs when logging in with a username and password (crate::authentication::Credentials::User).

You can use respond_to_challenge to continue the authentication process once the SMS code has been captured.

OAuthError(Error)

An error occured with the Ring OAuth endpoint.

InvalidResponse(Error)

The response from the Ring OAuth API could not be decoded.

UnsupportedChallenge(String)

Ring presented a challenge which was not expected, and is currently not supported by the crate.

SessionFailed

Setting the session details with Ring failed.

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

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for AuthenticationError

fn from(source: Error) -> Self

Converts to this type from the input type.