Enum ErrorClass 

#[non_exhaustive]
pub enum ErrorClass {
    Retryable,
    Fatal,
    Unknown,
}

The coarse answer to “may I try this call again”: see Error::class.

Examples

use brokapi_core::{Error, ErrorClass};

assert_eq!(Error::Unknown.class(), ErrorClass::Unknown);
assert_eq!(Error::NotReconciled.class(), ErrorClass::Fatal);

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.

Retryable

The call failed for a reason that can pass: the network, a rate limit. Reading calls may be repeated, after the delay in Error::RateLimited if there is one. For a command this class is not a licence to repeat: first find out what the broker has (see Error::Transport), and ask Error::retryable_for_command in a retry loop of commands.

Fatal

The same call will fail again until something else changes: a setup, a refused request, a missing capability, a gate that is closed. Do not repeat it unchanged.

Unknown

The outcome of a command is not known: Error::Unknown. Repeating the command could create a second order. The library never repeats it and neither should the caller before it knows the state of the order.

Trait Implementations

impl Clone for ErrorClass

fn clone(&self) -> ErrorClass

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ErrorClass

impl Debug for ErrorClass

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ErrorClass

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ErrorClass

impl PartialEq for ErrorClass

fn eq(&self, other: &ErrorClass) -> 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 Serialize for ErrorClass

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ErrorClass