Enum LeaderElectionError

pub enum LeaderElectionError {
    InvalidState(String),
    InvalidParticipantId,
    ParticipantIdTooLarge {
        encoded_size: usize,
        limit: usize,
    },
    InvalidLeaseDuration,
    RevisionExhausted,
    Fdb(FdbError),
    Binding(Box<FdbBindingError>),
    PackError(PackError),
}

Leader-election-specific errors.

LeaderElectionError::Fdb retains the underlying FoundationDB error for the caller’s transaction runner to classify. The other variants identify invalid local configuration, unsupported durable data, or a protocol limit.

Variants

InvalidState(String)

The durable state could not be decoded or violated a protocol invariant.

Do not treat this as an unowned state. It can indicate corrupt data, an incompatible schema, or data written outside this recipe.

InvalidParticipantId

A ParticipantId was empty.

Empty text cannot distinguish a participating process incarnation.

ParticipantIdTooLarge

A ParticipantId exceeds the encoded-size limit.

The limit includes tuple encoding and NUL escaping, so it guarantees the complete durable election state fits below FoundationDB’s value limit.

Fields

encoded_size: usize

Tuple-encoded participant ID size in bytes.

limit: usize

Maximum supported tuple-encoded participant ID size in bytes.

InvalidLeaseDuration

A configured lease duration was zero.

A zero duration would make every local validity interval immediately expired, so super::LeaderElection::new rejects it.

RevisionExhausted

The durable revision reached u64::MAX.

No further ownership transition can create a strictly newer fencing rank in this election subspace.

Fdb(FdbError)

An underlying FoundationDB read, write, or commit-related error occurred.

Inspect the source error and let the enclosing transaction runner apply its normal retry policy where appropriate.

Binding(Box<FdbBindingError>)

A transaction-runner error occurred.

PackError(PackError)

Failed to encode or decode the recipe’s durable tuple state.

On reads this can accompany malformed or incompatible durable data; on writes it prevents staging the requested state change.

Trait Implementations

impl Debug for LeaderElectionError

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

Formats the value using the given formatter.

impl Display for LeaderElectionError

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

Formats the value using the given formatter.

impl Error for LeaderElectionError

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<FdbBindingError> for LeaderElectionError

fn from(error: FdbBindingError) -> Self

Converts to this type from the input type.

impl From<FdbError> for LeaderElectionError

fn from(error: FdbError) -> 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 From<PackError> for LeaderElectionError

fn from(error: PackError) -> Self

Converts to this type from the input type.

impl RetryableError for LeaderElectionError

The source() chain exposes wrapped FoundationDB errors, so the default retry decision is transparent to Database::run.

fn retry_decision(&self) -> RetryDecision

Classifies this error for the retry loop.