Struct ErrorResponse 

#[non_exhaustive]
pub struct ErrorResponse {
    pub status: StatusCode,
    pub headers: HeaderMap,
    pub body: String,
    pub message: String,
    pub retry_after: Option<Duration>,
}

An unsuccessful response, read whole: what ApiError::Response carries.

The send loop builds one when the client’s policy fails a response, and a venue’s From<ApiError> decodes its own body shape from body.

Its Debug, which the Request failed ERROR line prints, names the headers without their values and truncates the message and the body.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

status: StatusCode

The response’s status.

headers: HeaderMap

The response’s headers.

body: String

The response’s body, verbatim, or "" when it could not be read.

message: String

The body’s error field, else its message field, else the body verbatim: the shape most venue hosts answer with.

retry_after: Option<Duration>

The response’s Retry-After, read by polyoxide_venue::parse_retry_after with no clamp, since it is surfaced, never slept on. A zero is None.

Implementations

impl ErrorResponse

pub fn new( status: StatusCode, headers: HeaderMap, body: impl Into<String>, ) -> Self

An unsuccessful response from its parts, its message and Retry-After read from them.

pub async fn read(response: Response) -> Self

Read response whole. A body that cannot be read is "".

Trait Implementations

impl Clone for ErrorResponse

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 ErrorResponse

Written by hand so a log line never carries a header’s value (a token, a cookie) or an unbounded body.

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

Formats the value using the given formatter.

impl From<ErrorResponse> for ApiError

fn from(response: ErrorResponse) -> Self

Converts to this type from the input type.