Struct ApiError 

pub struct ApiError {
    pub code: u16,
    pub message: String,
    pub details: Option<String>,
}

API error response

Fields

code: u16

HTTP status code

message: String

Error message

details: Option<String>

Optional error details

Implementations

impl ApiError

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

Create a new API error

pub fn with_code(self, code: ApiErrorCode) -> Self

Set error code

pub fn with_details(self, details: impl Into<String>) -> Self

Set error details

pub fn not_found(resource: &str, id: &str) -> Self

Create a “not found” error

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

Create an “invalid input” error

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

Create a “conflict” error

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

Create an “internal error”

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

Create a “forbidden” error

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

Create a “not implemented” error

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<'de> Deserialize<'de> for ApiError

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ServiceError> for ApiError

Convert from service layer errors

fn from(error: ServiceError) -> Self

Converts to this type from the input type.

impl IntoResponse for ApiError

Available on crate feature http only.

Implement Axum’s IntoResponse for ApiError (only when http feature is enabled)

fn into_response(self) -> Response

Create a response.

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.

impl<'__s> ToSchema<'__s> for ApiError

fn schema() -> (&'__s str, RefOr<Schema>)

Return a tuple of name and schema or reference to a schema that can be referenced by the name or inlined directly to responses, request bodies or parameters.

fn aliases() -> Vec<(&'__s str, Schema)>

Optional set of alias schemas for the ToSchema::schema.