Struct xstack_kad::KBucketTable

pub struct KBucketTable<const K: usize> { /* private fields */ }

A rust implementation of the k-bucket data structure outlined in the Kademlia paper

Unlike the paper description, the only data stored by this implementation is the PeerId, develpers can call lookup_peer_info function to get the more data associated with the it.

Implementations

impl<const K: usize> KBucketTable<K>

pub async fn bind(switch: &Switch) -> Self

Create a k-bucket table for provides switch

pub fn k_const(&self) -> usize

Returns the const k value of the k-bucket.

pub fn len(&self) -> usize

Get the size of the routing table.

pub async fn insert(&self, peer_id: PeerId)

Try insert a peer into the routing table, If you need to understand why PeerId is probabilistically inserted into the routing table, see the Kademlia paper

pub async fn closest<Q>(&self, key: Q) -> Result<Vec<PeerId>>

where Q: Into<KBucketKey>,

Return the closest K peers for the input key.

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.