Struct ApiError 

pub struct ApiError {
    pub error: ErrorBody,
}

Standardized API error response.

This is the top-level error response returned by all API endpoints.

Fields

error: ErrorBody

The error details

Implementations

impl ApiError

pub fn new(code: ErrorCode) -> Self

Creates a new API error with the given code.

Uses the default message for the error code.

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

Creates a new API error with a custom message.

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

Creates a new API error with a custom message and details.

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

Adds details to an existing error.

pub fn status_code(&self) -> StatusCode

Returns the HTTP status code for this error.

pub fn license_not_found() -> Self

License not found error.

pub fn license_not_found_key(key: &str) -> Self

License not found with key in message.

pub fn invalid_field(field: &str, reason: &str) -> Self

Invalid request error with field details.

pub fn missing_field(field: &str) -> Self

Missing required field error.

pub fn not_found(resource: &str) -> Self

Resource not found error.

pub fn database_error() -> Self

Database error (internal details hidden from client).

pub fn internal_error() -> Self

Internal server 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 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<ClientError> for ApiError

fn from(err: ClientError) -> Self

Converts to this type from the input type.

impl From<LicenseError> for ApiError

fn from(err: LicenseError) -> Self

Converts to this type from the input type.

impl IntoResponse for ApiError

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.