Enum ErrorCode 

#[non_exhaustive]
pub enum ErrorCode {
    Usage,
    NotFound,
    Auth,
    Forbidden,
    RateLimit,
    Network,
    Api,
    Validation,
    Ambiguous,
    Conflict,
    CircuitOpen,
    BulkheadFull,
}

Machine-readable error categories, shared with the other HEY SDKs.

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.

Usage

The call was asked for wrongly: a bad argument, a URL that will not parse.

NotFound

There is no such record.

Auth

HEY wants credentials the call did not carry, or refused the ones it did.

Forbidden

The credentials are good but do not reach this far.

RateLimit

Too many calls, whether HEY said so with a 429 or the client’s own limiter refused it.

Network

No answer came at all: a connection, DNS or timeout failure.

Api

HEY answered with a failure the other categories do not name.

Validation

HEY refused the contents of the request.

Ambiguous

A name matched more than one record.

Conflict

The request conflicts with what HEY already holds.

CircuitOpen

The scope’s circuit breaker is open, so the SDK refused the call itself. See crate::resilience.

BulkheadFull

The scope already has as many calls in flight as its bulkhead allows.

Implementations

impl ErrorCode

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

The category’s name as the other HEY SDKs spell it: not_found, rate_limit.

pub fn exit_code(&self) -> i32

The process exit status a command should end with for this category. A conflict leaves with EXIT_VALIDATION: both mean the server refused what was asked of it. A call the SDK refused for itself leaves with EXIT_API, which is where Go’s ExitCodeFor sends the codes it does not name.

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 Copy for ErrorCode

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ErrorCode