Enum ApiError 

pub enum ApiError {
    Unauthorized,
    Forbidden,
    IndexerBackpressureUpsert,
    IndexerBackpressureTombstone,
    EventPublishFailed {
        after: WriteEffect,
    },
    ReconcileInProgress,
    ReconcileUnsupported,
    EventsGone {
        requested: EventId,
        oldest: EventId,
    },
    EventsUnavailable {
        message: String,
    },
    Core(Error),
    Storage(StorageError),
    PreconditionFailed,
    RangeNotSatisfiable {
        complete_length: u64,
    },
    NotModified,
    MalformedRange(String),
    LineRangeNotSatisfiable {
        line_total: u64,
        byte_total: u64,
    },
    ReplaceNoMatch,
    ReplaceAmbiguous {
        count: u64,
    },
}

HTTP-layer error — maps domain and storage errors to HTTP status codes.

Variants

Unauthorized

The request lacked valid Bearer credentials.

Forbidden

The credential is valid, but the knowledge base’s access policy does not grant this operation on this key.

Distinct from Self::Unauthorized on purpose: 401 tells a caller that credentials might help, and 403 tells them that theirs are fine and the answer is still no. D43 reserved this code for exactly this.

IndexerBackpressureUpsert

Indexer queue was full while enqueueing an upsert (PUT/COPY).

IndexerBackpressureTombstone

Indexer queue was full while enqueueing a tombstone (DELETE).

EventPublishFailed

The change event could not be published after storage had already taken the write (D55). Answered like indexer backpressure: 503 with Retry-After, so the client retries the idempotent write.

Fields

after: WriteEffect

What storage had already done.

ReconcileInProgress

A reconciliation pass for this knowledge base is already running (D67).

ReconcileUnsupported

The storage backend has no on-demand reconciliation pass (D67).

EventsGone

A Last-Event-ID older than what the event log retains.

Fields

requested: EventId

The position the subscriber asked to resume after.

oldest: EventId

The oldest position still held.

EventsUnavailable

The event log could not be subscribed to.

Fields

message: String

What the adapter reported.

Core(Error)

A domain error from notedthat-core.

Built through the manual From<CoreError> rather than #[from], so a CoreError::Storage(BucketNotFound) — which core’s own From<StorageError> produces — is caught on the way in and answered like every other missing bucket, with no bucket name on the wire.

Storage(StorageError)

A storage-layer error not otherwise promoted to a top-level variant.

Note: StorageError::NotModified, StorageError::PreconditionFailed, and StorageError::RangeNotSatisfiable are promoted via the manual From<StorageError> impl to top-level ApiError variants so that IntoResponse can emit the RFC-required headers (e.g. Content-Range: bytes */N for 416).

PreconditionFailed

A conditional PUT/DELETE failed because a precondition was not met.

Maps to HTTP 412 Precondition Failed.

RangeNotSatisfiable

The requested byte range could not be satisfied.

complete_length is the total object size in bytes. The IntoResponse impl emits Content-Range: bytes */complete_length per RFC 7233 §4.4.

Fields

complete_length: u64

Total object size in bytes.

NotModified

The backend returned 304 Not Modified for a conditional GET/HEAD.

Maps to HTTP 304 with no body, as required by RFC 7232 §4.1.

MalformedRange(String)

The Range: header value could not be parsed per RFC 7233.

Maps to HTTP 400 Bad Request.

LineRangeNotSatisfiable

A Range: lines=… header specified a range that exceeds the object’s line count.

Maps to HTTP 416 with Content-Range: lines */<line_total> and X-Content-Range-Bytes: */<byte_total> per the line-range extension.

Fields

line_total: u64

Total line count in the object.

byte_total: u64

Total byte count in the object.

ReplaceNoMatch

A single-replace operation found no occurrence of old_string.

ReplaceAmbiguous

A single-replace operation found multiple occurrences of old_string.

Fields

count: u64

Number of occurrences found.

Trait Implementations

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, __formatter: &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<Error> for ApiError

Promote specific StorageError variants to top-level ApiError variants so that IntoResponse can emit the RFC-mandated response headers.

fn from(e: CoreError) -> Self

Converts to this type from the input type.

impl From<StorageError> for ApiError

fn from(e: StorageError) -> Self

Converts to this type from the input type.

impl From<WriteError> for ApiError

fn from(e: WriteError) -> Self

Converts to this type from the input type.

impl IntoResponse for ApiError

fn into_response(self) -> Response

Create a response.