Struct ApiError 

pub struct ApiError {
    pub status: StatusCode,
    pub code: String,
    pub message: String,
    pub details: Option<Value>,
}

An API error. Every field is sent to the client.

Fields

status: StatusCode

code: String

message: String

details: Option<Value>

Implementations

impl ApiError

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

Build an error from a status, a code and a message.

pub fn with_details(self, details: Value) -> Self

Attach a details payload, such as a map of field errors.

pub fn with_field(self, field: impl Into<String>) -> Self

Shorthand for details of {"field": "..."}.

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

Build an error with the canonical code for status, so every framework surface names the same status the same way (#1193).

pub fn logged(status: StatusCode, context: &str, message: impl Display) -> Self

from_status, except a 5xx goes through error::server_error_body: logged under context, and sent only when RUSTANGO_DISCLOSE_ERRORS allows it.

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

400 Bad Request — code = "bad_request".

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

401 Unauthorized — code = "unauthorized".

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

403 Forbidden — code = "forbidden".

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

404 Not Found — code = "not_found".

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

409 Conflict — code = "conflict".

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

422 Unprocessable Entity — code = "validation_failed".

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

429 Too Many Requests — code = "rate_limited".

pub fn rate_limited_response( message: impl Into<String>, retry_after_secs: u64, ) -> Response

A finished 429 response with Retry-After, as every rate limiter sends it.

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

500 Internal Server Error — code = "internal_error". Pass a generic message; log the real cause instead of sending it to the client.

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

503 Service Unavailable — code = "service_unavailable".

pub fn to_json(&self) -> Value

Render the error as JSON, without building a response.

Trait Implementations

impl Clone for ApiError

fn clone(&self) -> Self

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<ApiError> for ProblemDetails

Available on crate feature admin only.

fn from(e: ApiError) -> Self

Converts to this type from the input type.

impl IntoResponse for ApiError

fn into_response(self) -> Response

Create a response.