Struct ApiError 

pub struct ApiError {
    pub code: ErrorCode,
    pub message: String,
}

Standard API error with error code and message

Fields

code: ErrorCode

message: String

Implementations

impl ApiError

pub fn new(code: ErrorCode, message: impl Into<String>) -> Self

Create a new ApiError with the given code and message

pub fn bad_request(message: impl Into<String>) -> Self

Create a BadRequest error (400)

pub fn unauthorized(message: impl Into<String>) -> Self

Create an Unauthorized error (401)

pub fn forbidden(message: impl Into<String>) -> Self

Create a Forbidden error (403)

pub fn not_found(message: impl Into<String>) -> Self

Create a NotFound error (404)

pub fn conflict(message: impl Into<String>) -> Self

Create a Conflict error (409)

pub fn too_many_requests(message: impl Into<String>) -> Self

Create a TooManyRequests error (429)

pub fn validation(message: impl Into<String>) -> Self

Create a ValidationError error (422)

pub fn internal(message: impl Into<String>) -> Self

Create an InternalError (500)

pub fn code(&self) -> ErrorCode

Get the error code

pub fn message(&self) -> &str

Get reference to the error message

Trait Implementations

impl Clone for ApiError

fn clone(&self) -> ApiError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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, __formatter: &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<ApiError> for ApiResult<T>

fn from(err: ApiError) -> Self

Converts to this type from the input type.

impl From<ApiError> for AppError

fn from(err: ApiError) -> Self

Converts to this type from the input type.

impl PartialEq for ApiError

fn eq(&self, other: &ApiError) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ApiError