Struct libp2p_kad::kbucket::Key
source · [−]pub struct Key<T> { /* private fields */ }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.
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
sourceimpl<T> Key<T>
impl<T> Key<T>
sourcepub fn new(preimage: T) -> Key<T> where
T: Borrow<[u8]>,
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.
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) -> Distance where
U: AsRef<KeyBytes>,
pub fn distance<U>(&self, other: &U) -> Distance where
U: AsRef<KeyBytes>,
Computes the distance of the keys according to the XOR metric.
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
sourceimpl From<Multihash<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>> for Key<Multihash>
impl From<Multihash<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>> for Key<Multihash>
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into)Uses borrowed data to replace owned data, usually by cloning. Read more