Struct libp2p_kad::kbucket::KBucketsTable

pub struct KBucketsTable<TPeerId, TVal> { /* fields omitted */ }

Table of k-buckets.

Methods

impl<TPeerId, TVal> KBucketsTable<TPeerId, TVal> where
    TPeerId: KBucketsPeerId + Clone, 

pub fn new(my_id: TPeerId, unresponsive_timeout: Duration) -> Self

Builds a new routing table.

pub fn my_id(&self) -> &TPeerId

Returns the ID of the local node.

pub fn entry<'a>(&'a mut self, peer_id: &'a TPeerId) -> Entry<'a, TPeerId, TVal>

Returns an object containing the state of the given entry.

pub fn entries_not_pending(&self) -> impl Iterator<Item = (&TPeerId, &TVal)>

Returns an iterator to all the peer IDs in the bucket, without the pending nodes.

Important traits for BucketsIter<'a, TPeerId, TVal>

impl<'a, TPeerId, TVal> Iterator for BucketsIter<'a, TPeerId, TVal> type Item = Bucket<'a, TPeerId, TVal>;

pub fn buckets(&mut self) -> BucketsIter<TPeerId, TVal>

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 find_closest(
    &mut self,
    id: &impl KBucketsPeerId<TPeerId>
) -> VecIntoIter<TPeerId>

Finds the nodes closest to id, ordered by distance.

Pending nodes are ignored.

Trait Implementations

impl<TPeerId: Clone, TVal: Clone> Clone for KBucketsTable<TPeerId, TVal>

fn clone(&self) -> KBucketsTable<TPeerId, TVal>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<TPeerId: Debug, TVal: Debug> Debug for KBucketsTable<TPeerId, TVal>

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

Formats the value using the given formatter.