Struct Problem

pub struct Problem(/* private fields */);

Problem is a reified error type, encoding it’s problem type as a uri.

Implementations

impl Problem

pub fn new() -> Self

Get a new Problem.

pub fn builder() -> ProblemBuilder

Get a new ProblemBuilder.

Methods from Deref<Target = ApiError>

pub fn set_status<T>(&mut self, status: T)

where T: Into<StatusCode>,

Set the StatusCode.

pub fn status(&self) -> StatusCode

Get the StatusCode.

pub fn set_title<T>(&mut self, title: T)

where T: Display,

This is an optional title which can be used to create a valuable output for consumers.

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

This is an optional title which can be used to create a valuable output for consumers.

pub fn set_message<T>(&mut self, message: T)

where T: Display,

Set a message that describes the error in a human readable form.

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

A message that describes the error in a human readable form.

pub fn set_type_url<T>(&mut self, type_url: T)

where T: Display,

Set a URL that points to a detailed description of the error.

If not set it will most probably become httpstatus.es.com/XXX when the problem response is generated.

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

A URL that points to a detailed description of the error.

pub fn set_instance<T>(&mut self, instance: T)

where T: Display,

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

A URL that points to a detailed description of the error.

pub fn set_source<E>(&mut self, source: E)

where E: Error + Send + Sync + 'static,

pub fn set_source_in_a_box<E>(&mut self, source: E)

where E: Into<Box<dyn Error + Sync + Send>>,

pub fn add_field<T, V>(&mut self, name: T, value: V) -> bool

where T: Into<String>, V: Serialize,

Adds a serializable field. If the serialization fails nothing will be added. This method returns true if the field was added and false if the field could not be added.

An already present field with the same name will be replaced.

pub fn try_add_field<T, V>( &mut self, name: T, value: V, ) -> Result<(), Box<dyn Error>>

where T: Into<String>, V: Serialize,

Adds a serializable field. If the serialization fails nothing will be added. This fails if a failure occurred while adding the field.

An already present field with the same name will be replaced.

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

Returns a reference to the serialized fields

pub fn fields_mut(&mut self) -> &mut HashMap<String, Value>

Returns a mutable reference to the serialized fields

pub fn extensions(&self) -> &Extensions

Get a reference to the extensions

Extensions will not be part of an HttpApiProblem

pub fn extensions_mut(&mut self) -> &mut Extensions

Get a mutable reference to the extensions

Extensions will not be part of an HttpApiProblem

pub fn to_http_api_problem(&self) -> HttpApiProblem

Creates an HttpApiProblem from this.

Note: If the status is StatusCode::UNAUTHORIZED fields will not be put into the problem.

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

If there is a message it will be the message otherwise the source error stringified

If none is present, None is returned

Trait Implementations

impl Debug for Problem

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

Formats the value using the given formatter.

impl Default for Problem

fn default() -> Self

Returns the “default value” for a type.

impl Deref for Problem

type Target = ApiError

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Problem

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Display for Problem

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

Formats the value using the given formatter.

impl Error for Problem

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<ApiError> for Problem

fn from(inner: ApiError) -> Self

Converts to this type from the input type.