Struct discv5::kbucket::Key

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

A Key is a cryptographic hash, identifying both the nodes participating in the Kademlia DHT, as well as records stored in the DHT.

The set of all Keys defines the Kademlia keyspace.

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.

A Key preserves the preimage of type T of the hash function. See Key::preimage.

Implementations

impl<T> Key<T>

pub fn new_raw(preimage: T, hash: GenericArray<u8, U32>) -> Key<T>

Construct a new Key by providing the raw 32 byte hash.

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: &Key<U>) -> Distance

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

pub fn log2_distance<U>(&self, other: &Key<U>) -> Option<u64>

Computes the integer log-2 distance between two keys, assuming a 256-bit key. The output returns None if the key’s are identical. The range is 1-256.

Trait Implementations

impl<TNodeId, TVal> AsRef<Key<TNodeId>> for ClosestValue<TNodeId, TVal>

fn as_ref(&self) -> &Key<TNodeId>

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

impl<TNodeId, TVal> AsRef<Key<TNodeId>> for PredicateValue<TNodeId, TVal>

fn as_ref(&self) -> &Key<TNodeId>

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

impl<TPeerId, TVal: Eq> AsRef<Key<TPeerId>> for EntryView<TPeerId, TVal>

fn as_ref(&self) -> &Key<TPeerId>

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

impl<TPeerId> AsRef<Key<TPeerId>> for Key<TPeerId>

fn as_ref(&self) -> &Key<TPeerId>

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 From<NodeId> for Key<NodeId>

fn from(node_id: NodeId) -> Self

Converts to this type from the input type.

impl<TNodeId> From<PredicateKey<TNodeId>> for Key<TNodeId>

fn from(key: PredicateKey<TNodeId>) -> Self

Converts to this type from the input type.

impl<T> PartialEq for Key<T>

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