Struct xstack_kad::kbucket::KBucketTable

pub struct KBucketTable<Key, Value, const K: usize>
where
    Key: KBucketKey,
{ /* private fields */ }

Implementations

impl<Key, Value, const K: usize> KBucketTable<Key, Value, K>

where Key: KBucketKey,

pub fn const_k() -> usize

Returns the const k value of the k-bucket.

pub fn new(local_key: Key) -> Self

Create a new KBucketsTable instance with local key value.

pub fn k(&self) -> usize

Return the parameter K of k-bucket.

pub fn local_key(&self) -> &Key

Returns the local node key.

pub fn len(&self) -> usize

Get the count of stored keys.

pub fn get(&self, key: &Key) -> Option<&Value>

where Key: PartialEq,

Returns value of given key.

pub fn insert<Q>(&mut self, key: Q, value: Value) -> Option<(Key, Value)>

where Key: From<Q> + PartialEq,

Push value into k-bucket’s bottom. and pop the LRU value from the k-bucket’s top if the k-bucket is full.

This function has no side effects if called with local_key.

pub fn remove(&mut self, key: &Key) -> Option<Value>

where Key: PartialEq,

Remove the keypair from the table.

Returns None, if the key is not exists.

pub fn closest_k(&self, target: &Key) -> KBucketTableIter<'_, Key, Value, K>

Returns an iterator of up to k keys closest to target.

pub fn iter(&self) -> KBucketTableIter<'_, Key, Value, K>

Returns an iterator over all inserted keys.

pub fn bucket_of_key(&self, key: &Key) -> Option<&KBucket<Key, Value>>

Get bucket of one key.