Struct ApiError

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

Represents a structured error that can be easily serialized and sent as an HTTP response.

Fields

kind: String

A machine-readable error type or category.

code: u16

The HTTP status code associated with this error. This field is not serialized.

message: String

A human-readable message describing the error.

details: Option<Value>

Optional structured details about the error.

Implementations

impl ApiError

pub fn new( code: u16, kind: &str, message: String, details: Option<Value>, ) -> Self

Creates a new ApiError.

Arguments

• code - The HTTP status code for this error.
• kind - A string slice representing the kind or category of the error.
• message - A String containing the descriptive message for the error.
• details - Optional serde_json::Value for structured error details.

Trait Implementations

impl Clone for ApiError

fn clone(&self) -> ApiError

Returns a copy 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, 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 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.