Struct libp2p_kad::kbucket::KBucketsTable

pub struct KBucketsTable<Id, Val> { /* fields omitted */ }

Table of k-buckets.

Methods

impl<Id, Val> KBucketsTable<Id, Val> where     Id: KBucketsPeerId,

pub fn new(my_id: Id, ping_timeout: Duration) -> Self

Builds a new routing table.

Important traits for BucketsIter<'a, Id, Val>

impl<'a, Id: 'a, Val: 'a> Iterator for BucketsIter<'a, Id, Val> type Item = Bucket<'a, Id, Val>;

pub fn buckets(&mut self) -> BucketsIter<Id, Val>

Returns an iterator to all the buckets of this table.

Ordered by proximity to the local node. Closest bucket (with max. one node in it) comes first.

pub fn my_id(&self) -> &Id

Returns the ID of the local node.

pub fn find_closest(&mut self, id: &Id) -> VecIntoIter<Id> where     Id: Clone,

Finds the num nodes closest to id, ordered by distance.

pub fn find_closest_with_self(&mut self, id: &Id) -> VecIntoIter<Id> where     Id: Clone,

Same as find_closest, but includes the local peer as well.

pub fn update(&mut self, id: Id, value: Val) -> UpdateOutcome<Id, Val>

Marks the node as "most recent" in its bucket and modifies the value associated to it. This function should be called whenever we receive a communication from a node.

Trait Implementations

impl<Id: Clone, Val: Clone> Clone for KBucketsTable<Id, Val>

fn clone(&self) -> KBucketsTable<Id, Val>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Id: Debug, Val: Debug> Debug for KBucketsTable<Id, Val>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.