Struct OAuthError 

pub struct OAuthError {
    pub code: OAuthErrorCode,
    pub description: Option<String>,
    pub uri: Option<String>,
    pub state: Option<String>,
}

An OAuth error: a code, and an optional description for a human.

Fields

code: OAuthErrorCode

description: Option<String>

uri: Option<String>

state: Option<String>

Echoed back on a redirect, so the client can match the response to the request it made.

Implementations

impl OAuthError

pub fn new(code: OAuthErrorCode) -> Self

pub fn because(code: OAuthErrorCode, description: impl Into<String>) -> Self

The description is shown to developers, so say what is actually wrong.

It must never quote the offending secret back — an error body ends up in logs, browser history and bug reports.

pub fn invalid_request(description: impl Into<String>) -> Self

pub fn invalid_client(description: impl Into<String>) -> Self

pub fn invalid_grant(description: impl Into<String>) -> Self

pub fn invalid_scope(description: impl Into<String>) -> Self

pub fn server_error(description: impl Into<String>) -> Self

pub fn with_state(self, state: Option<String>) -> Self

pub fn with_uri(self, uri: impl Into<String>) -> Self

pub fn from_json(body: &Json) -> Option<OAuthError>

Read an error out of a provider’s JSON response.

Providers are not uniform here: some send a bare string, some an object, and some send 200 OK with an error body. The client checks for the field regardless of status, which is why this is lenient.

pub fn to_json(&self) -> Json

pub fn to_query(&self) -> String

The error=... query string appended to a redirect URI, per §4.1.2.1.

Trait Implementations

impl Clone for OAuthError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OAuthError

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

Formats the value using the given formatter.

impl Display for OAuthError

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

Formats the value using the given formatter.

impl Error for OAuthError

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

fn from(error: OAuthError) -> Error

Converts to this type from the input type.

impl From<StateError> for OAuthError

Every state failure is invalid_request: the callback was malformed as a request, whatever the reason, and saying which reason to the provider would be describing our own defence to whoever tripped it.

fn from(error: StateError) -> OAuthError

Converts to this type from the input type.

impl IntoResponse for OAuthError

fn into_response(self) -> Response