Struct libp2p::kad::KBucketKey
source · pub struct KBucketKey<T> { /* private fields */ }
Available on crate feature
kad
only.Expand description
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.
Key
s 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§
source§impl<T> Key<T>
impl<T> Key<T>
sourcepub fn new(preimage: T) -> Key<T>
pub fn new(preimage: T) -> Key<T>
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
.
sourcepub fn into_preimage(self) -> T
pub fn into_preimage(self) -> T
Converts the key into its preimage.
sourcepub fn distance<U>(&self, other: &U) -> Distancewhere
U: AsRef<KeyBytes>,
pub fn distance<U>(&self, other: &U) -> Distancewhere
U: AsRef<KeyBytes>,
Computes the distance of the keys according to the XOR metric.
sourcepub fn hashed_bytes(&self) -> &[u8] ⓘ
pub fn hashed_bytes(&self) -> &[u8] ⓘ
Exposing the hashed bytes.
sourcepub fn for_distance(&self, d: Distance) -> KeyBytes
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§
source§impl<T, U> PartialEq<Key<U>> for Key<T>
impl<T, U> PartialEq<Key<U>> for Key<T>
impl<T> Eq for Key<T>
Auto Trait Implementations§
impl<T> RefUnwindSafe for Key<T>where
T: RefUnwindSafe,
impl<T> Send for Key<T>where
T: Send,
impl<T> Sync for Key<T>where
T: Sync,
impl<T> Unpin for Key<T>where
T: Unpin,
impl<T> UnwindSafe for Key<T>where
T: UnwindSafe,
Blanket Implementations§
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Checks if this value is equivalent to the given key. Read more
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to
key
and return true
if they are equal.