Struct ApiError 

pub struct ApiError {
    pub status: StatusCode,
    pub error_type: String,
    pub message: String,
    pub fields: Option<Vec<FieldError>>,
    /* private fields */
}

Standard API error type

Provides structured error responses following a consistent JSON format.

Example

use rustapi_core::ApiError;
use http::StatusCode;

// Create a custom error
let error = ApiError::new(StatusCode::CONFLICT, "duplicate", "Email already exists");
assert_eq!(error.status, StatusCode::CONFLICT);
assert_eq!(error.error_type, "duplicate");

// Use convenience constructors
let not_found = ApiError::not_found("User not found");
assert_eq!(not_found.status, StatusCode::NOT_FOUND);

let bad_request = ApiError::bad_request("Invalid input");
assert_eq!(bad_request.status, StatusCode::BAD_REQUEST);

Fields

status: StatusCode

HTTP status code

error_type: String

Error type identifier

message: String

Human-readable error message

fields: Option<Vec<FieldError>>

Optional field-level validation errors

Implementations

impl ApiError

pub fn new( status: StatusCode, error_type: impl Into<String>, message: impl Into<String>, ) -> Self

Create a new API error

pub fn validation(fields: Vec<FieldError>) -> Self

Create a validation error with field details

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

Create a 400 Bad Request error

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

Create a 401 Unauthorized error

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

Create a 403 Forbidden error

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

Create a 404 Not Found error

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

Create a 409 Conflict error

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

Create a 500 Internal Server Error

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

Add internal details (for logging, hidden from response in prod)

impl ApiError

pub fn from_validation_error(err: ValidationError) -> Self

Create a validation error from a ValidationError

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

Create a 503 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 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 From<Error> for ApiError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for ApiError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for ApiError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<ValidationError> for ApiError

fn from(err: ValidationError) -> Self

Converts to this type from the input type.

impl IntoResponse for ApiError

fn into_response(self) -> Response

Convert self into a Response

impl ResponseModifier for ApiError

fn update_response(op: &mut Operation)

Update the operation with response information