Enum KeyError 

#[non_exhaustive]
pub enum KeyError {
    Malformed {
        text: String,
        reason: &'static str,
    },
    UnknownProduct {
        venue: String,
        product: String,
    },
    WrongProduct {
        expected: String,
        found: String,
    },
    InvalidId {
        product: String,
        id: String,
        reason: String,
    },
}

Why text or a key named no instrument a product could read. Every one is an InvalidRequest: the caller named something no request can carry.

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.

Malformed

The text is not venue.product:id.

Fields

text: String

The text, as given.

reason: &'static str

What is wrong with it.

UnknownProduct

No product this build enables has the key’s venue and product ids.

Fields

venue: String

The venue id, as written.

product: String

The product id, as written.

WrongProduct

A product was handed a key of another product.

Fields

expected: String

The product that was asked, as venue.product.

found: String

The key’s product, as venue.product.

InvalidId

The product does not read the id as one of its own.

Fields

product: String

The product, as venue.product.

id: String

The id, as given.

reason: String

Why the product refused it.

Implementations

impl KeyError

pub fn unknown(raw: &RawKey) -> Self

The error for a raw key whose venue and product no enabled product has.

Trait Implementations

impl Classify for KeyError

An InvalidRequest, whatever the case.

fn class(&self) -> Class

The class of this error.

fn is_fault(&self) -> bool

Whether this error is a fault, rather than the venue answering as designed. False only for defined outcomes, such as a Fill-And-Kill order that matched nothing, or a venue that does not serve the caller’s region. Alerting should key on this; retrying should not.

fn retry_after(&self) -> Option<Duration>

How long the server asked the caller to wait. Defaults to the class’s own; an error whose wait outlives its class, such as a ban that says when it lifts, overrides it. Never Some of zero.

fn is_retriable(&self) -> bool

Whether retrying could plausibly succeed, read from the class (see Class::is_retriable).

impl Clone for KeyError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyError

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

Formats the value using the given formatter.

impl Display for KeyError

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

Formats the value using the given formatter.

impl Eq for KeyError

impl Error for KeyError

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 PartialEq for KeyError

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for KeyError