Enum RaftError 

#[non_exhaustive]
pub enum RaftError {
    Storage(LogError),
    Network(ClientError),
    Protocol(ProtocolError),
    ControllerAdmin(String),
    Records(RecordsError),
    MalformedControlRecord(&'static str),
    Metadata(MetadataError),
    Unsupported(&'static str),
    NotLeader {
        current_leader: Option<NodeId>,
    },
    LeaderUnknown,
    ChangeRejected(String),
    StaleMetadataImage,
    UncommittedTail,
    ClusterAuthorizationFailed,
    ReconfigRejected(String),
    ReconfigInProgress,
    DuplicateVoter(NodeId),
    VoterNotFound(NodeId),
    InvalidVoterUpdate(String),
    UnsupportedKraftVersion(u16),
    VoterNotCaughtUp {
        id: NodeId,
        lag: u64,
    },
    SerdeFailed(WriteError),
    SerdeFailedDecode(ReadError),
    PersistedFormat {
        artifact: &'static str,
        path: PathBuf,
        problem: PersistedFormatError,
    },
    UnsupportedPrivateVersion {
        api_key: i16,
        version: i16,
    },
    MetadataReplay(MetadataReplayError),
    Startup(String),
    ControllerListenerBind {
        addr: SocketAddr,
        source: Error,
    },
    FatalFault(String),
    Shutdown,
}

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.

Storage(LogError)

Network(ClientError)

Protocol(ProtocolError)

ControllerAdmin(String)

Records(RecordsError)

MalformedControlRecord(&'static str)

A record of a control batch lacks its key or value, or has an empty one. The message is the text of Kafka’s RecordsIterator.decodeControlRecord.

Metadata(MetadataError)

Unsupported(&'static str)

NotLeader

Fields

current_leader: Option<NodeId>

LeaderUnknown

ChangeRejected(String)

StaleMetadataImage

A leader-local mutation was planned from an image that has since changed. The caller must read a fresh image and repeat its admission checks.

UncommittedTail

The leader refused a compare-and-set because its log holds records that are not committed yet.

A break-glass consume and a topic-freeze replacement check the committed image, so the leader decides them only when its whole log is committed. A newly elected leader is in this state until it commits a record from its own epoch. Kafka’s controller is not active in the same window, and it answers NOT_CONTROLLER. The refusal clears when the tail commits, so a caller can retry.

A diskless offset reservation gets the same refusal until the leader has committed its own epoch. The leader reserves no offsets before that.

ClusterAuthorizationFailed

The controller refused a request because the principal of the connection lacks the cluster operation that the request needs.

ReconfigRejected(String)

ReconfigInProgress

DuplicateVoter(NodeId)

VoterNotFound(NodeId)

InvalidVoterUpdate(String)

UnsupportedKraftVersion(u16)

VoterNotCaughtUp

Fields

id: NodeId

lag: u64

SerdeFailed(WriteError)

SerdeFailedDecode(ReadError)

PersistedFormat

A node-local file in the metadata partition directory has a version this build does not read, or does not parse. The node does not start on it.

Fields

artifact: &'static str

The file’s name, such as quorum-state.

path: PathBuf

problem: PersistedFormatError

UnsupportedPrivateVersion

A peer answered a krabka-private controller RPC with UNSUPPORTED_VERSION: it does not implement version of api_key. A mixed-version cluster meets it during a rolling upgrade.

Fields

api_key: i16

version: i16

MetadataReplay(MetadataReplayError)

A committed metadata log record that this controller cannot replay. The controller stops.

Startup(String)

ControllerListenerBind

The controller listener could not bind its address. Kafka’s SocketServer fails its start the same way, with Socket server failed to bind to and the address. It is a network failure, not a storage one.

Fields

addr: SocketAddr

The address the listener tried to bind.

source: Error

Why the bind failed, such as Address already in use.

FatalFault(String)

The controller met a fault that Kafka’s ProcessTerminatingFaultHandler halts the process over, such as a replay of a FeatureLevelRecord above the range this controller supports. The text is the Encountered fatal fault: prefix of that handler’s log line, then the message of the exception that caused the fault. Kafka’s own failureMessage between the two, such as Unable to apply FeatureLevelRecord record at offset N on active controller, ..., is not part of it.

Shutdown

Trait Implementations

impl Debug for RaftError

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

Formats the value using the given formatter.

impl Display for RaftError

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

Formats the value using the given formatter.

impl Error for RaftError

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<ClientError> for RaftError

fn from(source: ClientError) -> Self

Converts to this type from the input type.

impl From<LogError> for RaftError

fn from(source: LogError) -> Self

Converts to this type from the input type.

impl From<MetadataError> for RaftError

fn from(source: MetadataError) -> Self

Converts to this type from the input type.

impl From<MetadataReplayError> for RaftError

fn from(source: MetadataReplayError) -> Self

Converts to this type from the input type.

impl From<ProtocolError> for RaftError

fn from(source: ProtocolError) -> Self

Converts to this type from the input type.

impl From<ReadError> for RaftError

fn from(source: ReadError) -> Self

Converts to this type from the input type.

impl From<RecordsError> for RaftError

fn from(source: RecordsError) -> Self

Converts to this type from the input type.

impl From<WriteError> for RaftError

fn from(source: WriteError) -> Self

Converts to this type from the input type.