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, 

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

Builds a new routing table.

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 my_id(&self) -> &TPeerId

Returns the ID of the local node.

pub fn get(&self, id: &TPeerId) -> Option<&TVal>

Returns the value associated to a node, if any is present.

Does not include pending nodes.

pub fn get_mut(&mut self, id: &TPeerId) -> Option<&mut TVal>

Returns the value associated to a node, if any is present.

Does not include pending nodes.

pub fn entry_mut(&mut self, id: &TPeerId) -> Option<&mut TVal> where
    TVal: Default, 

Returns the value associated to a node if any is present. Otherwise, tries to add the node to the table in a disconnected state and return its value. Returns None if id is the local peer, or if the table is full.

pub fn set_connected(&mut self, id: &TPeerId) -> Update<TPeerId> where
    TVal: Default, 

Reports that we are connected to the given node.

This inserts the node in the k-buckets, if possible. If it is already in a k-bucket, puts it above the disconnected nodes. If it is not already in a k-bucket, then the value will be built with the Default trait.

pub fn set_disconnected(&mut self, id: &TPeerId)

Reports that we are now disconnected from the given node.

This does not remove the node from the k-buckets, but moves it underneath the nodes we are still connected to.

pub fn find_closest<TOther>(&mut self, id: &TOther) -> VecIntoIter<TPeerId> where
    TPeerId: Clone + KBucketsPeerId<TOther>, 

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

pub fn find_closest_with_self<TOther>(
    &mut self,
    id: &TOther
) -> VecIntoIter<TPeerId> where
    TPeerId: Clone + KBucketsPeerId<TOther>, 

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

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.