Enum ErrorCode 

#[non_exhaustive]
pub enum ErrorCode {
    BadRequest,
    DisabledApiKey,
    ForbiddenIp,
    ForbiddenOrigin,
    ForbiddenIpOrigin,
    Internal,
    InsufficientCredits,
    InvalidApiKey,
    InvalidAsn,
    InvalidFilterSyntax,
    InvalidIpAddress,
    MissingApiKey,
    ReservedAsn,
    ReservedIpAddress,
    TooManyAsns,
    TooManyIps,
    TooManyRequests,
    TooManyUserAgents,
    UnknownAsn,
    Other(String),
}

A strongly typed Ipregistry API error code. It lets callers branch on error conditions without matching on raw strings. See https://ipregistry.co/docs/errors for the authoritative list.

Codes not known to this version of the crate are preserved verbatim in ErrorCode::Other.

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.

BadRequest

The request is malformed.

DisabledApiKey

The API key exists but is disabled.

ForbiddenIp

Lookups for this IP address are not allowed for the API key.

ForbiddenOrigin

Requests from this origin are not allowed for the API key.

ForbiddenIpOrigin

Requests from this IP address or origin are not allowed.

Internal

The API encountered an internal error.

InsufficientCredits

The account has no credits left.

InvalidApiKey

The API key is not valid.

InvalidAsn

The requested Autonomous System Number is malformed.

InvalidFilterSyntax

The fields selection expression is malformed.

InvalidIpAddress

The requested IP address is malformed.

MissingApiKey

No API key was supplied.

ReservedAsn

The requested Autonomous System Number is reserved.

ReservedIpAddress

The requested IP address is reserved (private, loopback, …).

TooManyAsns

The batch request contains more ASNs than allowed.

TooManyIps

The batch request contains more IP addresses than allowed.

TooManyRequests

The API key is rate limited and the limit was exceeded.

TooManyUserAgents

The request contains more User-Agent strings than allowed.

UnknownAsn

The requested Autonomous System Number is unknown.

Other(String)

An error code this version of the crate does not know about, preserved verbatim.

Implementations

impl ErrorCode

pub fn from_raw(raw: &str) -> Self

Parses a raw API error code, mapping unrecognized codes to ErrorCode::Other.

pub fn as_str(&self) -> &str

Returns the raw form of the code, as returned by the API.

Trait Implementations

impl Clone for ErrorCode

fn clone(&self) -> ErrorCode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ErrorCode

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

Formats the value using the given formatter.

impl Display for ErrorCode

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

Formats the value using the given formatter.

impl Eq for ErrorCode

impl Hash for ErrorCode

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ErrorCode

fn eq(&self, other: &ErrorCode) -> 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.

impl StructuralPartialEq for ErrorCode