Struct NodeBucketStorage

pub struct NodeBucketStorage { /* private fields */ }

Implements the XOR distance-based bucketing system described in BEP0005 (more or less).

NodeBucketStorage keeps one bucket with capacity k for each bit of the DHT’s info hashes. Since the mainline DHT uses 20 byte (160 bit) info hashes, this object will by default keep a maximum of 160 buckets of size k.

As described in BEP0005, the buckets are organized according to an XOR distance metric so that Nodes with ids closer to our DHT’s Id are given the most storage space. The first bucket stores Nodes that have a zero (or more) bit prefix in common with the DHT Id. The second bucket stores Nodes that have a one (or more) bit prefix in common with the DHT Id. Two or more bits in the third. Three or more bits in the 4th. And so on.

Implementations

impl NodeBucketStorage

pub fn new(our_id: Id, k: usize) -> NodeBucketStorage

Create a new NodeBucketStorage.

Parameters

• our_id - the current Id of the DHT node that will use this object for storage. Nodes will be assigned to buckets based on the XOR distance between their Id and this one.
• k - the number of nodes that can be stored in a bucket.

Trait Implementations

impl Clone for NodeBucketStorage

fn clone(&self) -> NodeBucketStorage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl NodeStorage for NodeBucketStorage

fn add_or_update(&mut self, node: Node, verified: bool)

Add a Node to storage, or update the record of a Node already in storage.

fn clear(&mut self)

Erase all Nodes from storage, resetting this object to its empty state

fn count(&self) -> (usize, usize)

Return the number of Nodes that have been verified (last_verified property is not None) and the number that haven’t.

fn get_all_unverified(&self) -> Vec<NodeWrapper>

Return a copy of the records for all the unverified Nodes

fn get_all_verified(&self) -> Vec<NodeWrapper>

Return a copy of the records for all verified Nodes

fn get_nearest_nodes(&self, id: &Id, exclude: Option<&Id>) -> Vec<Node>

Return a copy of the nearest nodes to the provided Id.

fn prune(&mut self, grace_period: Duration, unverified_grace_period: Duration)

Prune (remove) records of Nodes tht haven’t been seen/verified recently.node_wrapper

fn set_id(&mut self, new_id: Id)

Set our own DHT node’s Id.