Struct ApiError 

pub struct ApiError { /* private fields */ }

A safe public API error rendered in Baukit’s standard JSON envelope.

The public code and message must be stable and safe for clients. Attach internal diagnostic errors with ApiError::internal; causes are logged at the request span and are never serialized.

Implementations

impl ApiError

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

Creates a public API error.

code should be a stable snake_case identifier and message must not contain internal or sensitive information.

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

Replaces the structured details object.

pub fn with_header(self, name: HeaderName, value: HeaderValue) -> Self

Adds a header to the error response.

A later call with the same name replaces the previous value. The request middleware always supplies the final X-Request-Id value.

pub fn with_retry_after(self, seconds: u64) -> Self

Adds a Retry-After response header using delta seconds.

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

Returns a 400 bad_request error with a safe message.

pub fn validation(details: BTreeMap<String, Value>) -> Self

Returns a 400 validation_failed error with structured field details.

pub fn validation_field( field: impl Into<String>, message: impl Into<String>, ) -> Self

Returns a validation error for one DTO field.

This is the concise form of ApiError::validation for the common case where a product has one field-level semantic or bounds error.

pub fn validation_fields<K, M, I>(fields: I) -> Self

where K: Into<String>, M: Into<String>, I: IntoIterator<Item = (K, M)>,

Returns a validation error containing multiple DTO field messages.

Field names are sorted in the serialized details object. If an iterator contains the same field more than once, the last message wins.

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

Returns a 401 unauthorized error with a safe message.

pub fn unauthenticated() -> Self

Returns the standard 401 unauthenticated authentication error.

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

Returns a 403 forbidden error with a safe message.

pub fn permission_denied() -> Self

Returns the standard 403 permission_denied authorization error.

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

Returns a 404 not_found error with a safe message.

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

Returns a 409 conflict error with a safe message.

pub fn method_not_allowed() -> Self

Returns a 405 method_not_allowed error with a stable safe message.

pub fn rate_limited() -> Self

Returns the standard 429 rate_limited error.

pub fn internal(error: impl StdError + Send + Sync + 'static) -> Self

Returns an opaque 500 internal error and retains its cause for logging.

pub const fn status(&self) -> StatusCode

Returns this error’s HTTP status.

pub fn code(&self) -> &str

Returns this error’s stable machine-readable code.

Trait Implementations

impl Debug for ApiError

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for ApiError

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for ApiError

fn source(&self) -> Option<&(dyn StdError + '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<IdempotencyError> for ApiError

fn from(error: IdempotencyError) -> Self

Converts to this type from the input type.

impl From<JsonRejection> for ApiError

fn from(_rejection: JsonRejection) -> Self

Converts to this type from the input type.

impl From<PaginationError> for ApiError

fn from(error: PaginationError) -> Self

Converts to this type from the input type.

impl From<PathRejection> for ApiError

fn from(_rejection: PathRejection) -> Self

Converts to this type from the input type.

impl From<PreconditionError> for ApiError

fn from(error: PreconditionError) -> Self

Converts to this type from the input type.

impl From<QueryRejection> for ApiError

fn from(_rejection: QueryRejection) -> Self

Converts to this type from the input type.

impl From<RevisionOutOfRange> for ApiError

fn from(error: RevisionOutOfRange) -> Self

Converts to this type from the input type.

impl IntoResponse for ApiError

fn into_response(self) -> Response

Create a response.