Enum ConsensusError 

pub enum ConsensusError {
    NotLeader {
        observed: Option<Epoch>,
    },
    Fenced {
        expected: Epoch,
        current: Epoch,
    },
    TransientDriver(Box<dyn Error + Send + Sync>),
    PermanentDriver(Box<dyn Error + Send + Sync>),
    AdvanceOutOfRange(u64),
    DenseUnsupported,
    SeqKeyCardinalityExceeded {
        cap: u64,
    },
    SeqOverflow,
    DenseNotActivated {
        required: u8,
        active: u8,
    },
    DenseBatchNotActivated {
        required: u8,
        active: u8,
    },
    LeasesUnsupported,
}

Errors returned by ConsensusDriver operations.

Driver implementations classify their internal failures into one of TransientDriver or PermanentDriver. The server uses that classification directly to pick a gRPC status code:

Variant	gRPC code	Client expectation
NotLeader	FAILED_PRECONDITION + LeaderHint	Retry against the new leader
Fenced	FAILED_PRECONDITION + LeaderHint	Retry against the new leader
TransientDriver	UNAVAILABLE	Safe to retry
PermanentDriver	INTERNAL	Do NOT silently retry
AdvanceOutOfRange	INTERNAL	Do NOT silently retry

Variants

NotLeader

Fields

observed: Option<Epoch>

Fenced

Fields

expected: Epoch

current: Epoch

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

A driver-level failure the caller MAY retry. Use for errors that are reasonably expected to clear on their own: storage I/O hiccup, peer transport flap, transient quorum loss.

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

A driver-level failure the caller MUST NOT silently retry. Use for persistent local fault: read-only filesystem, corruption, gone storage device, bad driver implementation, invariant violation.

AdvanceOutOfRange(u64)

A high-water advance whose physical_ms value exceeds the 46-bit timestamp layout’s cap. Carries the offending value structurally so the server can format and route it without downcasting through Box<dyn Error>. Semantically permanent (a saturated or misconfigured clock), so the server surfaces it as INTERNAL rather than retrying. See reject_out_of_range_advance for the propose-time guard.

DenseUnsupported

SeqKeyCardinalityExceeded

Fields

cap: u64

SeqOverflow

DenseNotActivated

Fields

required: u8

active: u8

DenseBatchNotActivated

Fields

required: u8

active: u8

LeasesUnsupported

Trait Implementations

impl Debug for ConsensusError

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

Formats the value using the given formatter.

impl Display for ConsensusError

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

Formats the value using the given formatter.

impl Error for ConsensusError

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.