Struct ResponseValidationError 

pub struct ResponseValidationError { /* private fields */ }

A successful HTTP response whose body this SDK could not read.

Reach it through ErrorKind::ResponseValidation. The raw body is kept, so a caller can recover data this version of the SDK does not model.

Implementations

impl ResponseValidationError

pub fn field_path(&self) -> &str

The dotted path to the field that was missing or of the wrong type, such as answers.spam.noul.

Empty when the body failed before any field could be named, which is what a syntax error or a document nested too deep gives.

pub fn status(&self) -> StatusCode

The response status, which was a success status.

pub fn headers(&self) -> &HeaderMap

The response headers, as they arrived.

pub fn request_id(&self) -> Option<&str>

The server’s identifier for this request, from x-typesafe-request-id.

The header’s text exactly as it arrived; Display and Debug show it escaped and cut at 128 characters instead.

pub fn endpoint(&self) -> Option<&str>

The method and URL the request went to, without credentials, query or fragment.

pub fn message(&self) -> &str

The sentence for this failure, Invalid response data at '<path>'..

pub fn body(&self) -> &[u8]

The response body, exactly as it arrived.

pub fn body_text(&self) -> Cow<'_, str>

The response body as text, with anything that is not UTF-8 replaced by U+FFFD.

pub fn body_json<'de, T>(&'de self) -> Result<T, DecodeError>

where T: Deserialize<'de>,

The response body, decoded as JSON.

This is how a caller recovers data the SDK’s own response type dropped, including whatever made the decode fail.

Errors

Returns a DecodeError when the body is not JSON, is nested deeper than this crate’s limit, or does not fit T.

pub fn decode_error(&self) -> &DecodeError

The decode failure underneath, which carries the position as well as the path.

Trait Implementations

impl Clone for ResponseValidationError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResponseValidationError

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

Prints what identifies the failure, and nothing that could be a secret; see the note on ApiError’s Debug.

impl Display for ResponseValidationError

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

Formats the value using the given formatter.

impl Error for ResponseValidationError

fn source(&self) -> Option<&(dyn StdError + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<ResponseValidationError> for Error

fn from(error: ResponseValidationError) -> Self

Converts to this type from the input type.