Enum Error 

#[non_exhaustive]
pub enum Error {
    Api(Box<ApiError>),
    Transport {
        outcome_unknown: bool,
        source: Error,
    },
    Decode {
        status: u16,
        source: Error,
    },
    InvalidRequest(String),
    Stream(String),
}

Everything a request can end in other than success.

Match on the variant and on ApiError::code, never on message text. The enum is #[non_exhaustive], so keep a catch-all arm.

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.

Api(Box<ApiError>)

The server answered and refused the request.

Transport

The request did not complete: connection refused, reset, timed out, or the response could not be read.

For a write, Error::is_outcome_unknown says whether the server may still have applied it. A transaction with an identity is safe to resubmit with the same id: the authority recognizes the retry as a duplicate instead of applying it twice.

Fields

outcome_unknown: bool

source: Error

Decode

The server answered successfully with a body this client could not decode.

Fields

status: u16

source: Error

InvalidRequest(String)

Refused before anything was sent: the request is not one the server could accept.

Stream(String)

An event stream ended with a reported authority error.

Implementations

impl Error

pub fn code(&self) -> Option<&str>

The stable error code, when the server reported one.

pub fn status(&self) -> Option<u16>

The HTTP status, when the server answered.

pub fn is_outcome_unknown(&self) -> bool

True when a write may or may not have been applied: it was sent, and no answer arrived. Reconcile by resubmitting a transaction with the same id, or by reading the state back.

pub fn precondition_failure(&self) -> Option<&PreconditionFailure>

The structured precondition failure of a refused transaction.

pub fn is_conflict(&self) -> bool

True for a refusal caused by state: a failed precondition or fence, a version, epoch or lease conflict, a record already present. Retry against fresh state, not unchanged.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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.