Enum ApiObservationError 

#[non_exhaustive]
pub enum ApiObservationError {
    ResourceMismatch {
        expected: EntityId,
        actual: EntityId,
    },
    ZeroReviewScanLimit,
    ReviewScanLimitExceeded {
        actual: u16,
        maximum: u16,
    },
    ReviewCursorTooLong {
        actual: usize,
        maximum: usize,
    },
    ResourceBoundReviewCursorTooLong {
        actual: usize,
        maximum: usize,
    },
    InvalidResourceBoundReviewCursor {
        reason: &'static str,
    },
    UnsupportedResourceBoundReviewCursorVersion,
    ResourceBoundReviewCursorMismatch,
    ObservationLimitExceeded {
        field: &'static str,
        actual: usize,
        maximum: usize,
    },
    Knowledge(KnowledgeBaseError),
    ReasoningAfterCommit {
        commit: Box<ApiObservationCommitReceipt>,
        source: RuleEngineError,
    },
}

Failure while accepting or reasoning over an API visibility observation.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

ResourceMismatch

The observation described a resource outside the host-selected scope.

Fields

expected: EntityId

Resource authorized by the caller.

actual: EntityId

Resource declared by the observation.

ZeroReviewScanLimit

A review query cannot make progress with an empty scan window.

ReviewScanLimitExceeded

A review query exceeded the compiled per-page scan ceiling.

Fields

actual: u16

Rejected requested relation count.

maximum: u16

Inclusive compiled ceiling.

ReviewCursorTooLong

A review cursor exceeded the relation-store identifier ceiling.

Fields

actual: usize

Rejected cursor byte length.

maximum: usize

Inclusive relation identifier ceiling.

ResourceBoundReviewCursorTooLong

A serialized resource-bound review cursor exceeded its compiled ceiling.

Fields

actual: usize

Rejected serialized cursor byte length.

maximum: usize

Inclusive compiled cursor ceiling.

InvalidResourceBoundReviewCursor

A serialized resource-bound review cursor was not canonical v2 syntax.

Fields

reason: &'static str

Stable parse reason that never contains cursor input.

UnsupportedResourceBoundReviewCursorVersion

A resource-bound review cursor used an unsupported wire version.

ResourceBoundReviewCursorMismatch

A resource-bound review cursor was replayed against another resource.

ObservationLimitExceeded

An observation field exceeded the review model’s storage ceiling.

Fields

field: &'static str

Stable field name (source.component).

actual: usize

Rejected UTF-8 byte count.

maximum: usize

Inclusive compiled ceiling.

Knowledge(KnowledgeBaseError)

The atomic evidence and relation write failed before anything committed.

ReasoningAfterCommit

Reasoning failed after the observation pair had committed.

Fields

commit: Box<ApiObservationCommitReceipt>

Committed observation that must not be retried as if no write occurred.

source: RuleEngineError

Rule evaluation or hypothesis-write failure.

Implementations

impl ApiObservationError

pub fn committed_observation(&self) -> Option<&ApiObservationCommitReceipt>

Returns the committed observation receipt when failure happened post-commit.

pub fn into_committed_observation(self) -> Option<ApiObservationCommitReceipt>

Takes the committed receipt without cloning it.

pub fn reasoning_source(&self) -> Option<&RuleEngineError>

Returns the post-commit reasoning error, when applicable.

Trait Implementations

impl Debug for ApiObservationError

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

Formats the value using the given formatter.

impl Display for ApiObservationError

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

Formats the value using the given formatter.

impl Error for ApiObservationError

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<ApiObservationError> for RuntimeApiVisibilityError

fn from(source: ApiObservationError) -> Self

Converts to this type from the input type.

impl From<KnowledgeBaseError> for ApiObservationError

fn from(source: KnowledgeBaseError) -> Self

Converts to this type from the input type.