Struct ApiError 

pub struct ApiError {
    pub status: StatusCode,
    pub code: &'static str,
    pub title: String,
    pub generation: Option<Generation>,
    pub balance_exhaustion: Option<BalanceExhaustion>,
    pub balance_shortfall: Option<BalanceShortfall>,
}

A refused control-plane request, rendered as an RFC-7807 application/problem+json body in the Problem shape.

A 401 also carries a Bearer challenge. A 5xx or usage-refused response adds an optional error_id that matches a warning on the tollgate::diagnostics target. Converting a StoreError never exposes its text, in the body or in Debug output (INVARIANTS.md 37).

Fields

status: StatusCode

The HTTP status, also sent as the body’s status.

code: &'static str

The stable machine code clients classify the refusal by. Part of the wire contract.

title: String

A short public description. Not a contract; classify by status and code.

generation: Option<Generation>

The tombstone’s generation on a revoked-principal refusal.

balance_exhaustion: Option<BalanceExhaustion>

The allocator’s evidence on a balance-exhausted refusal.

balance_shortfall: Option<BalanceShortfall>

The remaining funding on an insufficient-balance refusal, when the allocator attested it.

Implementations

impl ApiError

pub fn unauthorized() -> Self

401 authentication-required: credentials are missing, invalid, expired or conflicting. The response carries a Bearer challenge.

pub fn forbidden() -> Self

403 scope-forbidden: the credential is valid, but its identity lacks the role this route requires.

pub fn not_found(code: &'static str, title: impl Into<String>) -> Self

404 with the given machine code and title.

pub fn revoked(generation: Generation) -> Self

410 revoked-principal: the principal’s snapshot is a tombstone. Carries the tombstone’s generation so a client can order it against the positive snapshots it holds (INVARIANTS.md 15).

pub fn bad_request(code: &'static str, title: impl Into<String>) -> Self

400 with the given machine code and title.

pub fn not_implemented(code: &'static str, title: impl Into<String>) -> Self

The backend cannot answer this at all, as opposed to answering “nothing” — a distinction a caller must be able to act on differently (GL-48).

Trait Implementations

impl Debug for ApiError

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

Formats the value using the given formatter.

impl From<AllocateError> for ApiError

fn from(e: AllocateError) -> Self

Converts to this type from the input type.

impl From<BudgetError> for ApiError

fn from(e: BudgetError) -> Self

Converts to this type from the input type.

impl From<CreateAccountError> for ApiError

fn from(e: CreateAccountError) -> Self

Converts to this type from the input type.

impl From<IngestError> for ApiError

fn from(error: IngestError) -> Self

Converts to this type from the input type.

impl From<JsonRejection> for ApiError

fn from(error: JsonRejection) -> Self

Converts to this type from the input type.

impl From<KeyError> for ApiError

fn from(e: KeyError) -> Self

Converts to this type from the input type.

impl From<KeySnapshotError> for ApiError

fn from(e: KeySnapshotError) -> Self

Converts to this type from the input type.

impl From<PathRejection> for ApiError

fn from(error: PathRejection) -> Self

Converts to this type from the input type.

impl From<PublishSnapshotError> for ApiError

fn from(e: PublishSnapshotError) -> Self

Converts to this type from the input type.

impl From<SetStatusError> for ApiError

fn from(e: SetStatusError) -> Self

Converts to this type from the input type.

impl From<SnapshotValidationError> for ApiError

fn from(error: SnapshotValidationError) -> Self

Converts to this type from the input type.

impl From<StoreError> for ApiError

fn from(_: StoreError) -> Self

Converts to this type from the input type.

impl IntoResponse for ApiError

fn into_response(self) -> Response

Create a response.