Struct LeaderEpoch 

pub struct LeaderEpoch(pub i32);

A partition leader epoch. KIP-320 wire type: int32.

This is a monotonic per-partition counter, and every leader change increments it. It fences stale leaders and it bounds follower log truncation. -1, the UNKNOWN_LEADER_EPOCH sentinel, is a valid wire value and round-trips as the inner i32. The type is ordered, so epochs compare directly. Advance to the next epoch with LeaderEpoch::next.

Note: the deterministic consensus core, krabka-kraft-core, tracks its own always-non-negative epoch as a u32, krabka_kraft_core::types::Epoch. krabka-raft converts to and from this wire type at the controller boundary.

Tuple Fields

0: i32

Implementations

impl LeaderEpoch

pub const UNKNOWN: Self

KIP-320 UNKNOWN_LEADER_EPOCH (-1): the leader epoch is unknown or unset. Examples are an older client, and a partition with no elected leader yet.

pub const INITIAL: Self

The epoch a partition’s first leader starts at (0).

pub const fn get(self) -> i32

The inner i32. Use it at the wire and generated boundary.

pub const fn is_known(self) -> bool

Whether this is a real epoch rather than the UNKNOWN sentinel.

pub const fn next(self) -> Self

The next epoch after this one. A leader change increments the epoch by one.

Trait Implementations

impl Clone for LeaderEpoch

fn clone(&self) -> LeaderEpoch

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for LeaderEpoch

impl Debug for LeaderEpoch

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

Formats the value using the given formatter.

impl Default for LeaderEpoch

fn default() -> LeaderEpoch

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for LeaderEpoch

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for LeaderEpoch

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

Formats the value using the given formatter.

impl Eq for LeaderEpoch

impl From<LeaderEpoch> for i32

fn from(value: LeaderEpoch) -> Self

Converts to this type from the input type.

impl From<i32> for LeaderEpoch

fn from(value: i32) -> Self

Converts to this type from the input type.

impl Hash for LeaderEpoch

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for LeaderEpoch

fn cmp(&self, other: &LeaderEpoch) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for LeaderEpoch

fn eq(&self, other: &LeaderEpoch) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<LeaderEpoch> for i32

fn eq(&self, other: &LeaderEpoch) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<i32> for LeaderEpoch

fn eq(&self, other: &i32) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for LeaderEpoch

fn partial_cmp(&self, other: &LeaderEpoch) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd<LeaderEpoch> for i32

fn partial_cmp(&self, other: &LeaderEpoch) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd<i32> for LeaderEpoch

fn partial_cmp(&self, other: &i32) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for LeaderEpoch

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for LeaderEpoch