Enum Error 

#[non_exhaustive]
pub enum Error {
    Transport(Error),
    Api {
        status: u16,
        code: Option<u32>,
        message: String,
    },
    Deserialize(Error),
    InvalidInput(String),
    RateLimited {
        retry_after: Option<Duration>,
    },
}

Errors returned by the ferric-fred client.

The library never panics on a network or parse failure — those surface here as Err. The enum is #[non_exhaustive] so new variants can be added without a breaking change (see ADR-0004).

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.

Transport(Error)

A connection, timeout, or TLS-level failure from the HTTP transport.

Api

FRED returned an error payload. FRED encodes errors in the response body with a code and message alongside the HTTP status.

Fields

status: u16

HTTP status code of the response.

code: Option<u32>

FRED’s own error code, when present in the body.

message: String

Human-readable error message.

Deserialize(Error)

A response body did not match the expected shape.

InvalidInput(String)

Caller-side validation failed before any request was made.

RateLimited

FRED rate-limited the request. Surfaced distinctly so callers can back off.

Fields

retry_after: Option<Duration>

Suggested delay before retrying, if FRED provided one.

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.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.