Enum OAuthErrorCode 

#[non_exhaustive]
pub enum OAuthErrorCode {
    InvalidRequest,
    InvalidClient,
    InvalidGrant,
    UnauthorizedClient,
    UnsupportedGrantType,
    InvalidScope,
    AccessDenied,
    UnsupportedResponseType,
    ServerError,
    TemporarilyUnavailable,
    InvalidToken,
    InsufficientScope,
    InvalidTarget,
    InvalidRedirectUri,
    InvalidClientMetadata,
    InvalidSoftwareStatement,
    UnapprovedSoftwareStatement,
    Other(String),
}

Machine-readable OAuth 2.0 error code

Covers the registered codes from RFC 6749 (authorization and token endpoints), RFC 6750 (bearer token usage), RFC 8707 (resource indicators) and RFC 7591 (dynamic client registration). Unregistered extension codes are preserved as OAuthErrorCode::Other.

Serializes to/from its snake_case wire form:

use volga_oauth_core::OAuthErrorCode;

let code = OAuthErrorCode::InvalidToken;
assert_eq!(code.as_str(), "invalid_token");
assert_eq!(OAuthErrorCode::from("invalid_token"), code);

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.

InvalidRequest

The request is missing a required parameter, includes an unsupported parameter value, repeats a parameter or is otherwise malformed

InvalidClient

Client authentication failed

InvalidGrant

The provided authorization grant or refresh token is invalid, expired or revoked

UnauthorizedClient

The authenticated client is not authorized to use this authorization grant type

UnsupportedGrantType

The authorization grant type is not supported by the authorization server

InvalidScope

The requested scope is invalid, unknown or malformed

AccessDenied

The resource owner or authorization server denied the request

UnsupportedResponseType

The authorization server does not support obtaining an authorization code using this method

ServerError

The server encountered an unexpected condition

TemporarilyUnavailable

The server is currently unable to handle the request

InvalidToken

The access token is expired, revoked, malformed or otherwise invalid (RFC 6750)

InsufficientScope

The request requires higher privileges than provided by the access token (RFC 6750)

InvalidTarget

The requested resource is invalid, missing, unknown or malformed (RFC 8707)

InvalidRedirectUri

The value of one or more redirection URIs is invalid (RFC 7591)

InvalidClientMetadata

The value of one of the client metadata fields is invalid (RFC 7591)

InvalidSoftwareStatement

The software statement presented is invalid (RFC 7591)

UnapprovedSoftwareStatement

The software statement is not approved for use by this authorization server (RFC 7591)

Other(String)

An unregistered extension error code

Implementations

impl OAuthErrorCode

pub fn as_str(&self) -> &str

Returns the snake_case wire form of this error code

pub fn status(&self) -> StatusCode

Returns the HTTP status code conventionally paired with this error code

Bearer-usage codes follow RFC 6750 Section 3.1 (invalid_token -> 401, insufficient_scope -> 403); invalid_client maps to 401 and the remaining token/authorization endpoint codes to 400 per RFC 6749 Section 5.2, except server_error (500) and temporarily_unavailable (503). Extension codes default to 400.

Trait Implementations

impl Clone for OAuthErrorCode

fn clone(&self) -> OAuthErrorCode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OAuthErrorCode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OAuthErrorCode

fn deserialize<__D>( __deserializer: __D, ) -> Result<OAuthErrorCode, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for OAuthErrorCode

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

Formats the value using the given formatter.

impl Eq for OAuthErrorCode

impl From<&str> for OAuthErrorCode

fn from(code: &str) -> OAuthErrorCode

Converts to this type from the input type.

impl From<OAuthErrorCode> for OAuthError

fn from(error: OAuthErrorCode) -> OAuthError

Converts to this type from the input type.

impl From<String> for OAuthErrorCode

fn from(code: String) -> OAuthErrorCode

Converts to this type from the input type.

impl Hash for OAuthErrorCode

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

where __H: Hasher,

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 OAuthErrorCode

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for OAuthErrorCode

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for OAuthErrorCode