Enum Error 

#[non_exhaustive]
pub enum Error {
    Auth,
    Invalid {
        detail: String,
    },
    RateLimited {
        retry_after: Option<Duration>,
    },
    Overloaded {
        retry_after: Option<Duration>,
    },
    Transport(Box<dyn Error + Send + Sync>),
    UnexpectedStatus {
        status: u16,
        body: String,
    },
    Protocol {
        detail: String,
    },
    Unsure {
        question: String,
        value: f64,
        threshold: f64,
    },
    Config {
        detail: String,
    },
}

Everything that can go wrong, from the wire to the policy.

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.

Auth

401: missing or invalid API key.

Invalid

422: the request body failed validation. detail is the verbatim response body.

Fields

detail: String

The response body, JSON envelope included; it names the offending field.

RateLimited

429 after every retry was used.

Fields

retry_after: Option<Duration>

The last retry-after the API sent, if any.

Overloaded

529 after every retry was used.

Fields

retry_after: Option<Duration>

The last retry-after the API sent, if any.

Transport(Box<dyn Error + Send + Sync>)

Connection, TLS, timeout, or body-read failure. A failure to connect — refused, reset, or a TLS handshake — is retried inside the same budget as a throttle. A timeout of any phase and a body failure are not: the client sets one deadline over the whole attempt, so a connect-phase timeout cannot be told apart from a read timeout, and retrying either would multiply the wall time that deadline promises.

UnexpectedStatus

A status the API contract does not define.

Fields

status: u16

HTTP status code.

body: String

Response body, verbatim.

Protocol

The response violated the contract: undecodable body, answer kind mismatch, unknown option or level, probability outside 0..=1, missing answer for a question.

Fields

detail: String

What was violated.

Unsure

The policy labelled the answer unsure and no fallback was given.

Fields

question: String

Question id (q0, q1, …) in encode order; the same id the wire and the span use.

value: f64

The probability (noul) or confidence (choice, score) that was judged.

threshold: f64

The boundary the value fell short of: the nearer band edge for noul, min_confidence for choice and score.

Config

Bad configuration: thresholds outside 0..=1, no_below > yes_above, missing key, empty batch, unserialisable state, empty or duplicate rubric.

Fields

detail: String

What was wrong.

Implementations

impl Error

pub fn kind(&self) -> &'static str

A stable, low-cardinality name for the variant: auth, invalid, rate_limited, overloaded, transport, unexpected_status, protocol, unsure or config.

This is the value of the error.type attribute on a failed span, so it is safe to group metrics by.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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.