Struct ErrorResponse

pub struct ErrorResponse {
    pub error: ErrorCode,
    pub description: Option<String>,
    pub uri: Option<String>,
}

Details about an error which occurred for an access token request.

For more information, see section 5.8.3 of RFC 9200.

Use the ErrorResponseBuilder (which you can access using the ErrorResponse::builder() method) to create an instance of this struct.

Example

For example, let us use the example from section 5.2 of RFC 6749:

{
      "error":"invalid_request"
}

Creating and serializing a simple error response telling the client their request was invalid would look like the following:

let error: ErrorResponse = ErrorResponse::builder()
    .error(ErrorCode::InvalidRequest)
    .build()?;
let mut serialized = Vec::new();
error.clone().serialize_into(&mut serialized)?;
assert_eq!(ErrorResponse::deserialize_from(serialized.as_slice())?, error);

---

1. Note that abbreviations aren’t used here, so keep in mind that the labels are really integers instead of strings. ↩

Fields

error: ErrorCode

Error code for this error.

Must be included.

See the documentation of ErrorCode for details.

description: Option<String>

Human-readable ASCII text providing additional information, used to assist the client developer in understanding the error that occurred.

uri: Option<String>

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.

Implementations

impl ErrorResponse

pub fn builder() -> ErrorResponseBuilder

Initializes and returns a new ErrorResponseBuilder.

Trait Implementations

impl Clone for ErrorResponse

fn clone(&self) -> ErrorResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ErrorResponse

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

Formats the value using the given formatter.

impl Hash for ErrorResponse

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ErrorResponse

fn eq(&self, other: &ErrorResponse) -> bool

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

const 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 ToCborMap for ErrorResponse

fn serialize_into<W>(self, writer: W) -> Result<(), Error<W::Error>>

where Self: Sized, W: Write, W::Error: Debug,

Serializes this type as a CBOR map bytestring into the given writer.

fn deserialize_from<R>(reader: R) -> Result<Self, Error<R::Error>>

where Self: Sized, R: Read, R::Error: Debug,

Deserializes from the given reader — which is expected to be an instance of this type, represented as a CBOR map bytestring — into an instance of this type.

fn to_ciborium_value(&self) -> Value

Converts this type to a CBOR serializable Value using to_cbor_map.

impl Eq for ErrorResponse

impl StructuralPartialEq for ErrorResponse