Struct poldercast::Id

pub struct Id(_);

this is a poldercast unique identifier.

It can be used for different purposes:

• the unique identifier the a node identifies itself within the topology;
• a mean to compare 2 nodes within the topology

The requirements from poldercast paper is that the Id is to be sortable and to occupy a circular value space.

Methods

impl Id

pub fn generate<R: RngCore>(rng: R) -> Self

Trait Implementations

impl AsRef<[u8]> for Id

fn as_ref(&self) -> &[u8]

Performs the conversion.

impl Clone for Id

fn clone(&self) -> Id

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Id

impl Debug for Id

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Id

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Id

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

Formats the value using the given formatter.

impl Eq for Id

impl From<[u8; 24]> for Id

fn from(v: [u8; 24]) -> Self

Performs the conversion.

impl FromStr for Id

type Err = FromHexError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Id

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, 

Feeds a slice of this type into the given [Hasher].

impl Ord for Id

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Id> for Id

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

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

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

This method tests for !=.

impl PartialOrd<Id> for Id

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

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

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

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

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

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

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

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

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

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

impl Serialize for Id

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for Id

impl StructuralPartialEq for Id