Enum ApiError 

pub enum ApiError {
    Unavailable {
        reason: String,
    },
    CeremonyNotFound {
        ceremony_id: String,
    },
    Conflict {
        what: String,
    },
    Refused {
        reason: String,
    },
}

How this contract fails.

Four shapes, because a consumer acts differently on each: waiting is a remedy for Unavailable, asking for something else is the remedy for CeremonyNotFound, reading the session again and trying once more is the remedy for Conflict, and Refused means the engine looked at the request and said no — retrying it unchanged will not change the answer.

Variants

Unavailable

Fields

reason: String

CeremonyNotFound

Fields

ceremony_id: String

Conflict

Somebody else wrote to what this call was writing to.

Distinct from Refused because the remedies are opposites: a refusal will answer the same way however often it is asked, while a lost race is worth reading again and repeating. Folding the two together makes a consumer either give up on races it would have won or hammer a call that will never succeed.

Fields

what: String

Refused

Fields

reason: String

Implementations

impl ApiError

pub fn is_transient(&self) -> bool

Whether trying again, unchanged, could plausibly succeed.

Published on the error rather than left to the consumer, because a consumer keeping its own table of which errors are worth retrying goes stale the first time this enum grows.

Trait Implementations

impl Clone for ApiError

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 ApiError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ApiError

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ApiError

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

Formats the value using the given formatter.

impl Eq for ApiError

impl Error for ApiError

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 ApiError

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ApiError

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 ApiError