Enum SpiError 

#[non_exhaustive]
pub enum SpiError {
    PartitionUnresolved {
        tried: Vec<PartitionKeySpecKind>,
    },
    PlacementMissing {
        partition: PartitionId,
    },
    PlacementBackend {
        retryable: bool,
    },
    UnsupportedEndpoint {
        endpoint: EndpointKind,
    },
    PrincipalAttrMissing {
        attr: String,
    },
    HeaderMissing {
        header: String,
    },
    IdRuleMissingPartition,
}

A failure returned by RoutingSpi or TenancySpi.

Examples

use osproxy_spi::SpiError;
use osproxy_spi::core::ErrorCode;

let err = SpiError::PlacementBackend { retryable: true };
assert_eq!(err.code(), ErrorCode::PlacementBackendUnavailable);
assert!(err.retryable());

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.

PartitionUnresolved

The partition could not be resolved from the request. Reports which source kinds were attempted (shape only).

Fields

tried: Vec<PartitionKeySpecKind>

The source kinds tried, in order, before giving up.

PlacementMissing

No placement exists for the resolved partition.

Fields

partition: PartitionId

The unresolved partition (an id, safe in telemetry).

PlacementBackend

The placement-lookup backend was unavailable.

Fields

retryable: bool

Whether the caller may retry the lookup.

UnsupportedEndpoint

The request endpoint is not supported for tenancy rewriting in this mode.

Fields

endpoint: EndpointKind

The endpoint classification that was rejected.

PrincipalAttrMissing

An injected field draws its value from a principal attribute that the authenticated principal does not carry. A configuration/identity mismatch, surfaced as a routing failure rather than silently injecting a null (which would corrupt isolation).

Fields

attr: String

The missing attribute name.

HeaderMissing

An injected field draws its value from a request header the request does not carry. Surfaced as a routing failure rather than injecting a null.

Fields

header: String

The missing header name.

IdRuleMissingPartition

A SharedIndex placement was configured with a doc-id rule that does not include the partition id, which would allow cross-tenant id collisions (docs/03). A configuration error, surfaced as a routing failure.

Implementations

impl SpiError

pub fn code(&self) -> ErrorCode

The stable ErrorCode for this failure, for trace attributes and /debug/explain.

pub fn retryable(&self) -> bool

Whether the caller may retry, possibly after re-resolving placement.

Trait Implementations

impl Debug for SpiError

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

Formats the value using the given formatter.

impl Display for SpiError

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

Formats the value using the given formatter.

impl Error for SpiError

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.