[][src]Struct libp2prs_kad::kbucket::Key

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

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>[src]

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

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[src]

Borrows the preimage of the key.

pub fn into_preimage(self) -> T[src]

Converts the key into its preimage.

pub fn distance<U>(&self, other: &U) -> Distance where
    U: AsRef<KeyBytes>, 
[src]

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

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

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>[src]

impl<T: Clone> Clone for Key<T>[src]

impl<T: Debug> Debug for Key<T>[src]

impl<T> Eq for Key<T>[src]

impl From<MultihashGeneric<Code>> for Key<Multihash>[src]

impl From<PeerId> for Key<PeerId>[src]

impl<T> Hash for Key<T>[src]

impl<T> Into<KeyBytes> for Key<T>[src]

impl<T, U> PartialEq<Key<U>> for Key<T>[src]

Auto Trait Implementations

impl<T> RefUnwindSafe for Key<T> where
    T: RefUnwindSafe
[src]

impl<T> Send for Key<T> where
    T: Send
[src]

impl<T> Sync for Key<T> where
    T: Sync
[src]

impl<T> Unpin for Key<T> where
    T: Unpin
[src]

impl<T> UnwindSafe for Key<T> where
    T: UnwindSafe
[src]

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> Pointable for T

type Init = T

The type for initializers.

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,