Struct oxide_auth::code_grant::error::AccessTokenError

pub struct AccessTokenError { /* private fields */ }

Represents parameters of an error in an Issuing Error Response.

This is used for both access token requests, and token refresh requests as they use the same internal error representations in the RFC as well.

Implementations

impl AccessTokenError

pub fn set_type(&mut self, new_type: AccessTokenErrorType)

Set error type

pub fn kind(&mut self) -> AccessTokenErrorType

Get the formal kind of error.

This can not currently be changed as to uphold the inner invariants for RFC compliance.

pub fn explain<D: Into<Cow<'static, str>>>(&mut self, description: D)

Provide a short text explanation for the error.

pub fn explain_uri(&mut self, uri: Url)

A uri identifying a resource explaining the error in detail.

pub fn iter(&self) -> <Self as IntoIterator>::IntoIter

Iterate over the key value pairs that describe this error.

These pairs must be added to the detailed description of an error. The pairs will be encoded in the json body of the Bad Request response.

Trait Implementations

impl Clone for AccessTokenError

fn clone(&self) -> AccessTokenError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AccessTokenError

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

Formats the value using the given formatter.

impl Default for AccessTokenError

fn default() -> Self

Construct a AccessTokenError with no extra information.

Will produce a generic InvalidRequest error without any description or error uri which would provide additional information for the client.

impl IntoIterator for &AccessTokenError

type Item = (&'static str, Cow<'static, str>)

The type of the elements being iterated over.

type IntoIter = IntoIter<(&'static str, Cow<'static, str>), Global>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for AccessTokenError

The error as key-value pairs.

type Item = (&'static str, Cow<'static, str>)

The type of the elements being iterated over.

type IntoIter = IntoIter<(&'static str, Cow<'static, str>), Global>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.