Enum FdbBindingError

#[non_exhaustive]
pub enum FdbBindingError {
    NonRetryableFdbError(FdbError),
    HcaError(HcaError),
    DirectoryError(DirectoryError),
    PackError(PackError),
    ReferenceToTransactionKept,
    CustomError(Box<dyn Error + Send + Sync>),
    ClientBudgetExceeded(BudgetExceeded),
    LeaderElectionError(LeaderElectionError),
}

This error represent all errors that can be throwed by db.run. Layer developers may use the CustomError.

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.

NonRetryableFdbError(FdbError)

HcaError(HcaError)

DirectoryError(DirectoryError)

PackError(PackError)

ReferenceToTransactionKept

A reference to the RetryableTransaction has been kept

CustomError(Box<dyn Error + Send + Sync>)

A custom error that layer developers can use

The retry loop of crate::Database::run recovers the underlying FdbError by walking the boxed error’s source() chain, so box the error itself (or a type that keeps the FdbError as its source()). Never box a stringified error (e.to_string().into()): the conversion destroys the source chain, and a retryable error becomes fatal.

ClientBudgetExceeded(BudgetExceeded)

The client-side budget of the transaction attempt was exceeded, as reported by crate::Transaction::check_client_budget

LeaderElectionError(LeaderElectionError)

Leader election specific error

Implementations

impl FdbBindingError

pub fn get_fdb_error(&self) -> Option<FdbError>

Returns the underlying FdbError, if any.

A CustomError boxing an FdbError or an FdbBindingError is checked first, then the whole source() chain is walked, so any error that carries an FdbError as its source() (however deeply nested) is found.

impl FdbBindingError

pub fn new_custom_error(e: Box<dyn Error + Send + Sync>) -> Self

create a new custom error

Trait Implementations

impl Debug for FdbBindingError

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

Formats the value using the given formatter.

impl Display for FdbBindingError

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

Formats the value using the given formatter.

impl Error for FdbBindingError

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 From<BudgetExceeded> for FdbBindingError

fn from(e: BudgetExceeded) -> Self

Converts to this type from the input type.

impl From<DirectoryError> for FdbBindingError

fn from(e: DirectoryError) -> Self

Converts to this type from the input type.

impl From<FdbBindingError> for RankedRegisterError

fn from(error: FdbBindingError) -> Self

Converts to this type from the input type.

impl From<FdbError> for FdbBindingError

fn from(e: FdbError) -> Self

Converts to this type from the input type.

impl From<HcaError> for FdbBindingError

fn from(e: HcaError) -> Self

Converts to this type from the input type.

impl From<LeaderElectionError> for FdbBindingError

fn from(error: LeaderElectionError) -> Self

Converts to this type from the input type.

impl RetryableError for FdbBindingError

fn retry_decision(&self) -> RetryDecision

Classifies this error for the retry loop.