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(&self, other: &U) -> Distance where
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

pub fn as_ref(&self) -> &KeyBytes

Performs the conversion.

source

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

source

pub 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

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

Formats the value using the given formatter. Read more

source

impl From<Key> for Key<Key>

source

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

Performs the conversion.

source

impl From<Multihash<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>> for Key<Multihash<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>>

source

pub fn from(
m: Multihash<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>
) -> Key<Multihash<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>>

Performs the conversion.

source

impl From<PeerId> for Key<PeerId>

source

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

Performs the conversion.

source

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

source

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

Performs the conversion.

source

impl<T> Hash for Key<T>

source

pub 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,

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

source

impl<T> Into<KeyBytes> for Key<T>

source

pub fn into(self) -> KeyBytes

Performs the conversion.

source

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

source

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

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

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 T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

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

source

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

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · source

pub 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 T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

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

source

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

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

source

Struct libp2p::kad::kbucket::Key

Implementations

impl<T> Key<T>

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

pub fn preimage(&self) -> &T

pub fn into_preimage(self) -> T

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

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

Trait Implementations

impl<T> AsRef<KeyBytes> for Key<T>

pub fn as_ref(&self) -> &KeyBytes

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

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

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

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

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

impl From<Key> for Key<Key>

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

impl From<Multihash<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>> for Key<Multihash<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>>

pub fn from( m: Multihash<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>) -> Key<Multihash<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>>

impl From<PeerId> for Key<PeerId>

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

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

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

impl<T> Hash for Key<T>

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

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

impl<T> Into<KeyBytes> for Key<T>

pub fn into(self) -> KeyBytes

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

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

fn ne(&self, other: &Rhs) -> bool

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<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

impl<T> Same<T> for T

type Output = T

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

type Owned = T

pub fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

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

pub fn vzip(self) -> V

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

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

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

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

pub fn from(
m: Multihash<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>
) -> Key<Multihash<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>>

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

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

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,

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

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

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

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

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

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

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

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

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

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