Struct openraft::log_id::LogId

pub struct LogId<NID: NodeId> {
    pub leader_id: CommittedLeaderId<NID>,
    pub index: u64,
}

The identity of a raft log.

The log id serves as unique identifier for a log entry across the system. It is composed of two parts: a leader id, which refers to the leader that proposed this log, and an integer index.

Fields

leader_id: CommittedLeaderId<NID>

The id of the leader that proposed this log

index: u64

The index of a log in the storage.

Log index is a consecutive integer.

Implementations

impl<NID: NodeId> LogId<NID>

pub fn new(leader_id: CommittedLeaderId<NID>, index: u64) -> Self

Creates a log id proposed by a committed leader with leader_id at the given index.

pub fn committed_leader_id(&self) -> &CommittedLeaderId<NID>

Returns the leader id that proposed this log.

Trait Implementations

impl<NID: Clone + NodeId> Clone for LogId<NID>

fn clone(&self) -> LogId<NID>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<NID: Debug + NodeId> Debug for LogId<NID>

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

Formats the value using the given formatter.

impl<NID: Default + NodeId> Default for LogId<NID>

fn default() -> LogId<NID>

Returns the “default value” for a type.

impl<'de, NID: NodeId> Deserialize<'de> for LogId<NID>

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<NID: NodeId> Display for LogId<NID>

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

Formats the value using the given formatter.

impl<NID: NodeId> MessageSummary<LogId<NID>> for LogId<NID>

fn summary(&self) -> String

Return a string of a big message

impl<NID: Ord + NodeId> Ord for LogId<NID>

fn cmp(&self, other: &LogId<NID>) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl<NID: PartialEq + NodeId> PartialEq for LogId<NID>

fn eq(&self, other: &LogId<NID>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<NID: PartialOrd + NodeId> PartialOrd for LogId<NID>

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<NID: NodeId> RaftLogId<NID> for LogId<NID>

fn get_log_id(&self) -> &LogId<NID>

Return a reference to the log-id it stores.

fn set_log_id(&mut self, log_id: &LogId<NID>)

Update the log id it contains.

fn leader_id(&self) -> &CommittedLeaderId<NID>

Returns a reference to the leader id that proposed this log id.

impl<NID: NodeId> Serialize for LogId<NID>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<NID: Copy + NodeId> Copy for LogId<NID>

impl<NID: Eq + NodeId> Eq for LogId<NID>

impl<NID: NodeId> StructuralPartialEq for LogId<NID>