Struct libp2p_kad::kbucket::Key

pub struct Key<T> { /* private fields */ }

A Key in the DHT keyspace with preserved preimage.

Keys in the DHT keyspace identify both the participating nodes, as well as the records stored in the DHT.

Keys have an XOR metric as defined in the Kademlia paper, i.e. the bitwise XOR of the hash digests, interpreted as an integer. See Key::distance.

Implementations

impl<T> Key<T>

pub fn new(preimage: T) -> Key<T>where
    T: Borrow<[u8]>,

Constructs a new Key by running the given value through a random oracle.

The preimage of type T is preserved. See Key::preimage and Key::into_preimage.

pub fn preimage(&self) -> &T

Borrows the preimage of the key.

pub fn into_preimage(self) -> T

Converts the key into its preimage.

pub fn distance<U>(&self, other: &U) -> Distancewhere
    U: AsRef<KeyBytes>,

Computes the distance of the keys according to the XOR metric.

pub fn for_distance(&self, d: Distance) -> KeyBytes

Returns the uniquely determined key with the given distance to self.

This implements the following equivalence:

self xor other = distance <==> other = self xor distance

Trait Implementations

impl<T> AsRef<KeyBytes> for Key<T>

fn as_ref(&self) -> &KeyBytes

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: Clone> Clone for Key<T>

fn clone(&self) -> Key<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Key<T>

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

Formats the value using the given formatter.

impl<T> From<Key<T>> for KeyBytes

fn from(key: Key<T>) -> KeyBytes

Converts to this type from the input type.

impl From<Key> for Key<Key>

fn from(k: Key) -> Self

Converts to this type from the input type.

impl From<Multihash<64>> for Key<Multihash>

fn from(m: Multihash) -> Self

Converts to this type from the input type.

impl From<PeerId> for Key<PeerId>

fn from(p: PeerId) -> Self

Converts to this type from the input type.

impl From<Vec<u8, Global>> for Key<Vec<u8>>

fn from(b: Vec<u8>) -> Self

Converts to this type from the input type.

impl<T> Hash for Key<T>

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<T, U> PartialEq<Key<U>> for Key<T>

fn eq(&self, other: &Key<U>) -> 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<T> Eq for Key<T>