Struct Error

pub struct Error { /* private fields */ }

Error object.

Implementations

impl Error

pub fn new(kind: &str, title: &str, status: StatusCode) -> Self

Create an error object.

pub fn set_kind(&mut self, kind: &str, title: &str) -> &mut Self

Set kind and title of the error.

pub fn kind(&self) -> &str

Return a kind for this error.

pub fn title(&self) -> &str

Return a title for this error.

pub fn set_status_code(&mut self, value: StatusCode) -> &mut Self

Set a status code information about the error.

pub fn status_code(&self) -> StatusCode

Return a status code for this error.

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

Return a detail for this error.

pub fn set_detail(&mut self, value: &str) -> &mut Self

Set detailed information about the error.

pub fn extras(&self) -> &HashMap<String, String>

Return all extras for this error.

pub fn set_extra(&mut self, key: &str, value: &str) -> &mut Self

Set detailed information about the error.

pub fn builder() -> Builder

Create an error builder object.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Error

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

fn source(&self) -> Option<&(dyn Error + '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<StatusCode> for Error

fn from(status: StatusCode) -> Self

Converts to this type from the input type.

impl ProblemDetailsMut for Error

fn set_kind(&mut self, kind: &str, title: &str) -> &mut Self

Set a kind and a title.

fn set_status_code(&mut self, value: StatusCode) -> &mut Self

Set a status code.

fn set_detail(&mut self, detail: &str) -> &mut Self

Set a detail.

impl ProblemDetailsReadOnly for Error

fn status_code(&self) -> StatusCode

Return the HTTP status code generated by the origin server for this occurrence of the problem.

fn kind(&self) -> &str

Return a URI reference RFC3986 that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be “about:blank”.

fn title(&self) -> &str

Return a short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization

fn detail(&self) -> Option<&str>

Return a human-readable explanation specific to this occurrence of the problem.

fn extras(&self) -> &HashMap<String, String>

Return all error related extra values.

impl Serialize for Error

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ProblemDetails for Error

Getters for Problem Details and accompanying metadata