Struct anyhow_http::HttpError

pub struct HttpError<R> {
    pub status_code: StatusCode,
    pub reason: Option<String>,
    pub source: Option<Error>,
    pub data: HashMap<String, Value>,
    /* private fields */
}

HttpError is an error that can be represented as a HTTP response. HttpError is generic over its response format, allowing consumers to implement their custom error response. See IntoHttpErrorResponse.

Fields

status_code: StatusCode

reason: Option<String>

source: Option<Error>

data: HashMap<String, Value>

Implementations

impl<R> HttpError<R>where R: Debug + Sync + Send + 'static,

pub fn from_status_code(status_code: StatusCode) -> Self

Creates a HttpError from a status code.

pub fn from_http_err<S>(http_err: HttpError<S>) -> Self

Creates a HttpError from another HttpError. This is mostly used to convert between HttpErrors with different response formats.

pub fn from_err<E>(err: E) -> Selfwhere E: Into<Error>,

Creates a HttpError from a generic error. It attempts to downcast to an underlying HttpError.

pub fn with_status_code(self, status_code: StatusCode) -> Self

Sets the status code.

pub fn with_reason<S: ToString>(self, reason: S) -> Self

Sets the error reason.

pub fn with_dyn_source_err( self, err: Box<dyn Error + Send + Sync + 'static> ) -> Self

Set the source error from a generic error trait object.

pub fn with_source_err<E>(self, err: E) -> Selfwhere E: Into<Error>,

Set the source error from a generic error.

pub fn add<V>(&mut self, key: impl Into<String>, value: V) -> Result<()>where V: Serialize + Send + Sync,

Adds a key-pair value to the inner data.

pub fn get<V>(&self, key: impl AsRef<str>) -> Option<V>where V: DeserializeOwned + Send + Sync,

Retrieves a key-pair value from the inner data.

impl<R> HttpError<R>where R: IntoHttpErrorResponse<Fmt = R> + Debug + Send + Sync + 'static,

pub fn into_http_error_response(self) -> HttpErrorResponse<R>

Creates an error response. See IntoHttpErrorResponse.

Trait Implementations

impl<R: Debug> Debug for HttpError<R>

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

Formats the value using the given formatter.

impl<R> Default for HttpError<R>

fn default() -> Self

Returns the “default value” for a type.

impl<R> Display for HttpError<R>

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

Formats the value using the given formatter.

impl<E, R> From<E> for HttpError<R>where E: Into<Error>, R: Debug + Sync + Send + 'static,

fn from(err: E) -> Self

Converts to this type from the input type.