Struct ApiError 

pub struct ApiError {
    pub error: ErrorDetail,
}

API error response format

This structure is returned by API endpoints when an error occurs. It follows a standard format with machine-readable error codes, human-readable messages, and optional contextual details.

Example JSON Response

{
  "error": {
    "code": "not_found",
    "message": "Download 123 not found",
    "details": {
      "download_id": 123
    }
  }
}

Fields

error: ErrorDetail

The error details

Implementations

impl ApiError

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

Create a new API error with code and message

pub fn with_details( code: impl Into<String>, message: impl Into<String>, details: Value, ) -> Self

Create an API error with additional details

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

Create a “not found” error

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

Create a “validation error” error

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

Create a “conflict” error

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

Create an “internal server error”

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

Create an “unauthorized” error

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

Create a “service unavailable” 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<Error> for ApiError

fn from(error: Error) -> Self

Converts to this type from the input type.

impl IntoResponse for ApiError

Implement IntoResponse for ApiError for explicit error responses

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.