Struct ApiError 

#[non_exhaustive]
pub struct ApiError {
    pub status: u16,
    pub code: String,
    pub message: String,
    pub hint: Option<String>,
    pub details: Option<Value>,
    pub request_id: Option<String>,
    pub retry_after_seconds: Option<u64>,
}

The Commit API’s error envelope plus transport metadata.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

status: u16

HTTP status code.

code: String

Stable machine-readable code, e.g. validation_failed, silicon_not_reachable.

message: String

What went wrong and why.

hint: Option<String>

What to do next, when the service gave one.

details: Option<Value>

Structured details the service marks safe to show (field errors, limits).

request_id: Option<String>

The request id (X-Request-Id or error.request_id).

retry_after_seconds: Option<u64>

Seconds to wait before retrying (Retry-After).

Implementations

impl ApiError

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

Creates an error value (useful in tests and mocks).

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

fn from(value: ApiError) -> Self

Converts to this type from the input type.

impl PartialEq for ApiError

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

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.

impl StructuralPartialEq for ApiError