Struct P2pNetworkKadRoutingTable

pub struct P2pNetworkKadRoutingTable<const K: usize = 20> {
    pub this_key: P2pNetworkKadKey,
    pub buckets: Vec<P2pNetworkKadBucket<K>>,
}

Kademlia routing table, with K parameter, the maximum number of records for each bucket. Usually it is set to 20.

Fields

this_key: P2pNetworkKadKey

SHA256 of the current node’s id.

buckets: Vec<P2pNetworkKadBucket<K>>

Kademlia K-buckets. Under index i located elements within distance 2^(256-i) from the current node at most. If there is also i+1 (i.e. i is not the last index), then distance from the current node to the elements under i are greater than 2^(256-i-1).

Implementations

impl<const K: usize> P2pNetworkKadRoutingTable<K>

pub fn new(this_entry: P2pNetworkKadEntry) -> P2pNetworkKadRoutingTable<K>

pub fn insert( &mut self, entry: P2pNetworkKadEntry, ) -> Result<bool, P2pNetworkKadRoutingTableInsertError>

Inserts the entry into the routing table.

Returns Ok(true) it is added as a new entry, and Ok(false) if an existing one has been updated.

If there is no space for adding the new entry (i.e. corresponding K-bucket is full and cannot be split), then Err(_) value is returned.

TODO: should it be just another variant in Ok(_)?

Filters entry.addrs for supported addresses if non of addresses are supported returns Err(_)

pub fn look_up(&self, key: &P2pNetworkKadKey) -> Option<&P2pNetworkKadEntry>

Looks up a Kademlia entry with the specified key.

pub fn find_node<'a>( &'a self, key: &'a P2pNetworkKadKey, ) -> impl Iterator<Item = &'a P2pNetworkKadEntry>

FIND_NODE backend. Returns iterator of nodes closest to the specified key, excluding nodes that correspond to the key itself and self.this_key.

The number of entries is limited to 20.

pub fn closest_peers<'a>( &'a self, key: &'a P2pNetworkKadKey, ) -> ClosestPeers<'a, K>

Returns iterator of nodes closest to the current one. TODO: use reverse order over bucket, from the deepest bucket.

Trait Implementations

impl<const K: usize> Clone for P2pNetworkKadRoutingTable<K>

fn clone(&self) -> P2pNetworkKadRoutingTable<K>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const K: usize> Debug for P2pNetworkKadRoutingTable<K>

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

Formats the value using the given formatter.

impl<const K: usize> Default for P2pNetworkKadRoutingTable<K>

fn default() -> P2pNetworkKadRoutingTable<K>

Returns the “default value” for a type.

impl<'de, const K: usize> Deserialize<'de> for P2pNetworkKadRoutingTable<K>

fn deserialize<__D>( __deserializer: __D, ) -> Result<P2pNetworkKadRoutingTable<K>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Extend<P2pNetworkKadEntry> for P2pNetworkKadRoutingTable

fn extend<T>(&mut self, iter: T)

where T: IntoIterator<Item = P2pNetworkKadEntry>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl<const K: usize> MallocSizeOf for P2pNetworkKadRoutingTable<K>

fn size_of(&self, ops: &mut MallocSizeOfOps) -> usize

Measure the heap usage of all descendant heap-allocated structures, but not the space taken up by the value itself.

impl<const K: usize> Serialize for P2pNetworkKadRoutingTable<K>

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&P2pNetworkKadRoutingTable> for RpcDiscoveryRoutingTable

type Error = DecodingError

The type returned in the event of a conversion error.

fn try_from(value: &P2pNetworkKadRoutingTable) -> Result<Self, Self::Error>

Performs the conversion.