Struct ParticipantId

pub struct ParticipantId(/* private fields */);

Identifies one caller process incarnation participating in an election.

Keep one ID for the lifetime of a process incarnation, then use a fresh ID after restart. Reusing an ID across concurrent callers is protocol misuse: fencing ranks preserve durable data safety, but the callers cannot safely coordinate leadership or protected work as one incarnation.

Implementations

impl ParticipantId

pub const MAX_ENCODED_BYTES: usize = 95_000usize

Maximum tuple-encoded size of a process-incarnation ID.

The limit includes the tuple string type code, terminator, and escaping of embedded NUL bytes. It leaves enough space for the rest of the durable election state below FoundationDB’s 100,000-byte value limit.

pub fn new(value: impl Into<String>) -> Result<Self>

Creates a non-empty process-incarnation ID within the encoded-size limit.

The value is persisted as the durable owner when this participant leads, so it must distinguish a restarted process from its previous incarnation.

pub fn as_str(&self) -> &str

Returns the caller-supplied process-incarnation ID as text.

Trait Implementations

impl Clone for ParticipantId

fn clone(&self) -> ParticipantId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ParticipantId

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

Formats the value using the given formatter.

impl Hash for ParticipantId

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 ParticipantId

fn cmp(&self, other: &ParticipantId) -> 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 ParticipantId

fn eq(&self, other: &ParticipantId) -> 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 ParticipantId

fn partial_cmp(&self, other: &ParticipantId) -> 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 Eq for ParticipantId

impl StructuralPartialEq for ParticipantId