Enum Error 

#[non_exhaustive]
pub enum Error {
    Api {
        message: String,
        http_status: Option<u16>,
        retry_after: Option<u64>,
    },
    Network {
        message: String,
    },
    InvalidArgument {
        message: String,
    },
}

All errors returned by this crate.

Every variant carries a human-readable message. API errors additionally carry the upstream HTTP status code, and HTTP 429 responses on the free plan also carry the Retry-After value the API asked us to honour (the paid endpoint does not send the header).

Match on the variant when you want to branch on the category, or call Error::error_type to get a stable category string ("api", "network", "invalid_argument").

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.

Api

The ipwhois.io API itself returned an error. Covers HTTP 4xx / 5xx responses, malformed JSON bodies, and HTTP 2xx responses where the API sets success: false (e.g. “Invalid IP address”, “Reserved range”).

Fields

message: String

Human-readable description from the API or synthesised by the client when the body is unparseable.

http_status: Option<u16>

HTTP status code, when the failure was an HTTP 4xx / 5xx. Absent for success: false bodies returned with HTTP 2xx.

retry_after: Option<u64>

Value of the Retry-After header, in seconds. Only present on HTTP 429 responses from the free plan (ipwho.is); the paid endpoint (ipwhois.pro) does not send the header.

Network

Transport-level failure: DNS, connection refused, TLS handshake, timeout, etc. The request never reached the API meaningfully.

Fields

message: String

Description of the underlying transport failure.

InvalidArgument

The caller supplied an invalid argument before any request was made (unsupported language, empty bulk list, more than 100 IPs, …).

Fields

message: String

Human-readable description of what was wrong.

Implementations

impl Error

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

Stable string identifying the category of this error.

Returns one of: "api", "network", or "invalid_argument".

pub fn message(&self) -> &str

Human-readable message for this error.

pub fn http_status(&self) -> Option<u16>

HTTP status code, if this is an Error::Api variant carrying one.

pub fn retry_after(&self) -> Option<u64>

Value of the Retry-After header in seconds, if available. Only present on HTTP 429 responses from the free plan.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

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(e: Error) -> Self

Converts to this type from the input type.