Struct KeyWithDistance

pub struct KeyWithDistance { /* private fields */ }

Helper structure. It wraps Kademlia distance to a given peer for heap-metrics.

Implementations

impl KeyWithDistance

pub fn new<K>(peer_id: PeerId, key: K) -> Self

where RecordKey: From<K>,

Creates a new KeyWithDistance instance with the given PeerId and K key.

The distance is calculated as the distance between the KademliaBucketKey derived from the PeerId and the KademliaBucketKey derived from the K key.

pub fn new_with_record_key(peer_id: PeerId, key: RecordKey) -> Self

Creates a new KeyWithDistance instance with the given PeerId and RecordKey.

pub fn record_key(&self) -> &RecordKey

Returns a reference to the record key.

Trait Implementations

impl Clone for KeyWithDistance

fn clone(&self) -> KeyWithDistance

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyWithDistance

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

Formats the value using the given formatter.

impl Hash for KeyWithDistance

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 KeyWithDistance

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

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

fn partial_cmp(&self, other: &Self) -> 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 KeyWithDistance