Enum AxonFlowError 

pub enum AxonFlowError {
    HttpError(Error),
    SerdeError(Error),
    ApiError {
        status: u16,
        message: String,
    },
    RateLimited {
        envelope: Box<RateLimitEnvelope>,
    },
    ConfigError(String),
    Unavailable(String),
    ObligationNotFulfillable(String),
}

Variants

HttpError(Error)

SerdeError(Error)

ApiError

Fields

status: u16

message: String

RateLimited

Tier-cap 429 with a parsed V1 upgrade envelope. Distinct from a generic 429 ApiError because callers should branch on the upgrade fields (tier / compare_url / buy_url) without re-parsing the raw body. Mirrors the cross-SDK 429-with-envelope pattern (#1982 / #1958). Boxed to keep AxonFlowError small — RateLimitEnvelope is ~176 bytes and would dominate the enum otherwise (clippy::result_large_err).

Fields

envelope: Box<RateLimitEnvelope>

ConfigError(String)

Unavailable(String)

ObligationNotFulfillable(String)

A Decision Mode redact_pii obligation could not be discharged through the engine — it named no request-phase fulfillment, advertised a content-type the PEP is not holding, named an endpoint this client will not call, the engine call failed / returned non-200, or the engine reported the redactor did not run (redaction_evaluated=false).

This is the fail-closed signal of the PEP contract (ADR-056, #2563): the caller MUST block, never forward the unredacted content. There is NO code path in which the SDK redacts locally — fulfillment is always the engine round-trip — so an obligation the engine cannot discharge fails closed here rather than leaking PII.

Implementations

impl AxonFlowError

pub fn is_retryable(&self) -> bool

pub fn is_fail_open_eligible(&self) -> bool

Whether this error should trigger fail-open (return a synthetic success response). Currently identical to [is_retryable]; maintained as a separate method because future policy changes may diverge them (e.g. ConfigError could be fail-open-eligible but not retryable).

Trait Implementations

impl Debug for AxonFlowError

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

Formats the value using the given formatter.

impl Display for AxonFlowError

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

Formats the value using the given formatter.

impl Error for AxonFlowError

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 AxonFlowError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for AxonFlowError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl PartialEq for AxonFlowError

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.