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§

source§

impl<T> Key<T>

source

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.

source

pub fn preimage(&self) -> &T

Borrows the preimage of the key.

source

pub fn into_preimage(self) -> T

Converts the key into its preimage.

source

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

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

source

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> AsRef<KeyBytes> for Key<T>

source§

fn as_ref(&self) -> &KeyBytes

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

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

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

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

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

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

Converts to this type from the input type.
source§

impl From<Key> for Key<Key>

source§

fn from(k: Key) -> Key<Key>

Converts to this type from the input type.
source§

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

source§

fn from(m: Multihash<64>) -> Key<Multihash<64>>

Converts to this type from the input type.
source§

impl From<PeerId> for Key<PeerId>

source§

fn from(p: PeerId) -> Key<PeerId>

Converts to this type from the input type.
source§

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

source§

fn from(b: Vec<u8, Global>) -> Key<Vec<u8, Global>>

Converts to this type from the input type.
source§

impl<T> Hash for Key<T>

source§

fn hash<H>(&self, state: &mut H)where H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl<T, U> PartialEq<Key<U>> for Key<T>

source§

fn eq(&self, other: &Key<U>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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.
source§

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§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CallHasher for Twhere T: Hash + ?Sized,

source§

default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64where H: Hash + ?Sized, B: BuildHasher,

source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same<T> for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

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

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

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

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more