Struct oauth2::StandardErrorResponse

pub struct StandardErrorResponse<T: ErrorResponseType> { /* fields omitted */ }

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: ErrorResponseType> StandardErrorResponse<T>

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

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. 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.

Trait Implementations

impl<T: Clone + ErrorResponseType> Clone for StandardErrorResponse<T>

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 + ErrorResponseType> Debug for StandardErrorResponse<T>

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

Formats the value using the given formatter.

impl<'de, T: ErrorResponseType> Deserialize<'de> for StandardErrorResponse<T> where
    T: ErrorResponseType, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::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<(), FormatterError>

Formats the value using the given formatter.

impl<T> ErrorResponse for StandardErrorResponse<T> where
    T: ErrorResponseType + 'static, 

impl<T: PartialEq + ErrorResponseType> PartialEq<StandardErrorResponse<T>> for StandardErrorResponse<T>

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl<T: ErrorResponseType> Serialize for StandardErrorResponse<T> where
    T: ErrorResponseType, 

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

Serialize this value into the given Serde serializer.

impl<T: ErrorResponseType> StructuralPartialEq for StandardErrorResponse<T>