Struct ApiError

pub struct ApiError {
    pub kind: ApiErrorKind,
    pub backtrace: Backtrace,
    pub extras: Option<Vec<(String, String)>>,
}

The main error type.

Fields

kind: ApiErrorKind

backtrace: Backtrace

extras: Option<Vec<(String, String)>>

Implementations

impl ApiError

pub fn render_404<B>(res: ServiceResponse<B>) -> Result<ErrorHandlerResponse<B>>

Render a 404 response

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)>

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<T> From<T> for ApiError

where ApiErrorKind: From<T>,

fn from(item: T) -> Self

Converts to this type from the input type.

impl ReportableError for ApiError

fn reportable_source(&self) -> Option<&(dyn ReportableError + 'static)>

Like [Error::source] but returns the source (if any) of this error as a [ReportableError] if it implements the trait. Otherwise callers of this method will likely subsequently call [Error::source] to return the source (if any) as the parent [Error] trait.

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

Return a Backtrace for this Error if one was captured

fn is_sentry_event(&self) -> bool

Whether this error is reported to Sentry

fn metric_label(&self) -> Option<&'static str>

Errors that don’t emit Sentry events (!is_sentry_event()) emit an increment metric instead with this label

fn extras(&self) -> Vec<(&str, String)>

Experimental: return key value pairs for Sentry Event’s extra data TODO: should probably return Vec<(&str, Value)> or Vec<(String, Value)>

fn tags(&self) -> Vec<(&str, String)>

Experimental: return tag key value pairs for metrics and Sentry

impl ResponseError for ApiError

fn status_code(&self) -> StatusCode

Returns appropriate status code for error.

fn error_response(&self) -> HttpResponse

Creates full response for error.

impl Serialize for ApiError

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.