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

TODO: highlights which module is utilizing the Id for proximity (I think this is rings).

There is 2 ways to create a new Id:

1. you can [generate] a new one;

   let id = Id::generate(&mut rng);

2. you can manually construct one;

   let id = Id::from(293088806904227309252857358049315044442);

Methods

impl Id

pub fn generate<Rng>(rng: &mut Rng) -> Self where
    Rng: RngCore, 

generate a new identifier utilizing the given Random Number Generator (RNG).

Trait Implementations

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 Ord for Id

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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 From<u128> for Id

fn from(v: u128) -> Self

Performs the conversion.

impl Eq for Id

impl Copy for Id

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 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 Debug for Id

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

Formats the value using the given formatter.