Struct OAuthError 

pub struct OAuthError {
    pub error: String,
    pub error_description: Option<String>,
    pub error_uri: Option<String>,
    pub state: Option<String>,
}

OAuth error response per RFC 6749 §5.2.

Use the constructor + chaining helpers to avoid specifying all four fields every time:

Example

use auth_framework::api::oauth2::OAuthError;

let err = OAuthError::new("invalid_request")
    .description("missing redirect_uri")
    .state("abc");
assert_eq!(err.error, "invalid_request");
assert_eq!(err.error_description.as_deref(), Some("missing redirect_uri"));

Fields

error: String

error_description: Option<String>

error_uri: Option<String>

state: Option<String>

Implementations

impl OAuthError

pub fn new(error: impl Into<String>) -> Self

Create a new error with the given error code (e.g. "invalid_request").

pub fn description(self, desc: impl Into<String>) -> Self

Set the human-readable error description.

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

Set the state parameter (echoed back from the authorization request).

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

Set the state parameter from an Option.

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

Set the error URI pointing to a page with more information.

Trait Implementations

impl Debug for OAuthError

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

Formats the value using the given formatter.

impl Serialize for OAuthError

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

where __S: Serializer,

Serialize this value into the given Serde serializer.