Struct StandardErrorResponse

pub struct StandardErrorResponse<T>
where
    T: ErrorResponseType,
{ /* private fields */ }

Available on crate feature experimental-oidc and crate feature e2e-encryption and non-WebAssembly only.

Error response returned by server after requesting an access token.

The fields in this structure are defined in Section 5.2 of RFC 6749. This trait is parameterized by a ErrorResponseType to support error types specific to future OAuth2 authentication schemes and extensions.

Implementations

impl<T> StandardErrorResponse<T>

where T: ErrorResponseType,

pub fn new( error: T, error_description: Option<String>, error_uri: Option<String>, ) -> StandardErrorResponse<T>

Instantiate a new ErrorResponse.

Arguments

• error - REQUIRED. A single ASCII error code deserialized to the generic parameter. ErrorResponseType.
• error_description - OPTIONAL. Human-readable ASCII text providing additional information, used to assist the client developer in understanding the error that occurred. Values for this parameter MUST NOT include characters outside the set %x20-21 / %x23-5B / %x5D-7E.
• error_uri - OPTIONAL. A URI identifying a human-readable web page with information about the error used to provide the client developer with additional information about the error. Values for the “error_uri” parameter MUST conform to the URI-reference syntax and thus MUST NOT include characters outside the set %x21 / %x23-5B / %x5D-7E.

pub fn error(&self) -> &T

REQUIRED. A single ASCII error code deserialized to the generic parameter ErrorResponseType.

pub fn error_description(&self) -> Option<&String>

OPTIONAL. Human-readable ASCII text providing additional information, used to assist the client developer in understanding the error that occurred. Values for this parameter MUST NOT include characters outside the set %x20-21 / %x23-5B / %x5D-7E.

pub fn error_uri(&self) -> Option<&String>

OPTIONAL. URI identifying a human-readable web page with information about the error, used to provide the client developer with additional information about the error. Values for the “error_uri” parameter MUST conform to the URI-reference syntax and thus MUST NOT include characters outside the set %x21 / %x23-5B / %x5D-7E.

Trait Implementations

impl<T> Clone for StandardErrorResponse<T>

where T: Clone + ErrorResponseType,

fn clone(&self) -> StandardErrorResponse<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for StandardErrorResponse<T>

where T: Debug + ErrorResponseType,

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for StandardErrorResponse<T>

where T: ErrorResponseType,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<TE> Display for StandardErrorResponse<TE>

where TE: ErrorResponseType + Display,

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

Formats the value using the given formatter.

impl<T> PartialEq for StandardErrorResponse<T>

where T: PartialEq + ErrorResponseType,

fn eq(&self, other: &StandardErrorResponse<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> Serialize for StandardErrorResponse<T>

where T: ErrorResponseType,

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<T> Eq for StandardErrorResponse<T>

where T: Eq + ErrorResponseType,

impl<T> ErrorResponse for StandardErrorResponse<T>

where T: ErrorResponseType + Display + 'static,

impl<T> StructuralPartialEq for StandardErrorResponse<T>

where T: ErrorResponseType,