Struct http_api_problem::ApiError

pub struct ApiError { /* private fields */ }

An error that should be returned from an API handler of a web service.

This should be returned from a handler as an error instead of a response or HttpApiProblem. Allows for logging etc. right before a response is generated.

Advantage over using an HttpApiProblem directly are that the StatusCode is mandatory and that this struct can also capture a source error which the HttpApiProblem does not since no error chains should be transmitted to clients.

Message on Display and converting to HttpApiProblem

When Display::fmt is invoked or when the details field of an HttpApiProblem is filled, the message field is used if present. If no message is set but there is a source error set, to_string() of the source will be used instead. Otherwise nothing will be displayed or set.

ApiError requires the feature api-error to be enabled.

Implementations

impl ApiError

pub fn builder<T: Into<StatusCode>>(status: T) -> ApiErrorBuilder

Get an ApiErrorBuilder with the given StatusCode preset.

pub fn try_builder<S: TryInto<StatusCode>>(
    status: S
) -> Result<ApiErrorBuilder, InvalidStatusCode> where
    S::Error: Into<InvalidStatusCode>, 

Try to get an ApiErrorBuilder with the given StatusCode preset.

Fails if the status argument can not be converted to a StatusCode

pub fn new<T: Into<StatusCode>>(status: T) -> Self

Create a new instance with the given StatusCode

pub fn try_new<S: TryInto<StatusCode>>(
    status: S
) -> Result<Self, InvalidStatusCode> where
    S::Error: Into<InvalidStatusCode>, 

Try to create a new instance with the given StatusCode

Fails if the status argument can not be converted to a StatusCode

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

Set the StatusCode.

pub fn status(&self) -> StatusCode

Get the StatusCode.

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

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: Display>(&mut self, message: T)

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: Display>(&mut self, type_url: T)

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: Display>(&mut self, instance: T)

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

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

pub fn set_source<E: Error + Send + Sync + 'static>(&mut self, source: E)

pub fn set_source_in_a_box<E: Into<Box<dyn Error + Send + Sync + 'static>>>(
    &mut self,
    source: E
)

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

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: Into<String>, V: Serialize>(
    &mut self,
    name: T,
    value: V
) -> Result<(), Box<dyn Error + 'static>>

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 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 into_http_api_problem(self) -> HttpApiProblem

Turns this into an HttpApiProblem.

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

pub fn into_hyper_response(self) -> Response<Body>

Creates a hyper response containing a problem JSON.

Requires the hyper feature

pub fn into_actix_web_response(self) -> HttpResponse

Creates a actix-web response containing a problem JSON.

Requires the actix.web feature

pub fn into_salvo_response(self) -> Response

Creates a salvo response containing a problem JSON.

Requires the salvo feature

pub fn into_tide_response(self) -> Response

Creates a tide response containing a problem JSON.

Requires the tide feature

Trait Implementations

impl Debug for ApiError

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

Formats the value using the given formatter.

impl Display for ApiError

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

Formats the value using the given formatter.

impl Error for ApiError

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

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

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

Returns a stack backtrace, if available, of where this error occurred.

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

impl From<ApiError> for HttpApiProblem

fn from(error: ApiError) -> Self

Converts to this type from the input type.

impl From<ApiError> for Response<Body>

fn from(error: ApiError) -> Response<Body>

Converts to this type from the input type.

impl From<ApiError> for HttpResponse

fn from(error: ApiError) -> Self

Converts to this type from the input type.

impl From<ApiError> for Response

fn from(error: ApiError) -> Response

Converts to this type from the input type.

impl From<ApiError> for Response

fn from(error: ApiError) -> Response

Converts to this type from the input type.

impl From<ApiErrorBuilder> for ApiError

fn from(builder: ApiErrorBuilder) -> Self

Converts to this type from the input type.

impl From<Error> for ApiError

fn from(error: Error) -> Self

Converts to this type from the input type.

impl From<Error> for ApiError

fn from(error: Error) -> Self

Converts to this type from the input type.

impl From<Error> for ApiError

fn from(error: Error) -> Self

Converts to this type from the input type.

impl From<Error> for ApiError

fn from(error: Error) -> Self

Converts to this type from the input type.

impl From<MailboxError> for ApiError

fn from(error: MailboxError) -> Self

Converts to this type from the input type.

impl From<StatusCode> for ApiError

fn from(s: StatusCode) -> Self

Converts to this type from the input type.

impl<T: IntoApiError> From<T> for ApiError

fn from(t: T) -> ApiError

Converts to this type from the input type.

impl ResponseError for ApiError

fn error_response(&self) -> HttpResponse

Creates full response for error.

fn status_code(&self) -> StatusCode

Returns appropriate status code for error.

impl Reject for ApiError