Struct libp2p::kad::kbucket::KBucketRef
source · pub struct KBucketRef<'a, TKey, TVal> { /* private fields */ }
Expand description
A reference to a bucket in a KBucketsTable
.
Implementations§
source§impl<'a, TKey, TVal> KBucketRef<'a, TKey, TVal>where
TKey: Clone + AsRef<KeyBytes>,
TVal: Clone,
impl<'a, TKey, TVal> KBucketRef<'a, TKey, TVal>where TKey: Clone + AsRef<KeyBytes>, TVal: Clone,
sourcepub fn range(&self) -> (Distance, Distance)
pub fn range(&self) -> (Distance, Distance)
Returns the minimum inclusive and maximum inclusive Distance
for
this bucket.
sourcepub fn num_entries(&self) -> usize
pub fn num_entries(&self) -> usize
Returns the number of entries in the bucket.
sourcepub fn has_pending(&self) -> bool
pub fn has_pending(&self) -> bool
Returns true if the bucket has a pending node.
sourcepub fn contains(&self, d: &Distance) -> bool
pub fn contains(&self, d: &Distance) -> bool
Tests whether the given distance falls into this bucket.
sourcepub fn rand_distance(&self, rng: &mut impl Rng) -> Distance
pub fn rand_distance(&self, rng: &mut impl Rng) -> Distance
Generates a random distance that falls into this bucket.
Together with a known key a
(e.g. the local key), a random distance d
for
this bucket w.r.t k
gives rise to the corresponding (random) key b
s.t.
the XOR distance between a
and b
is d
. In other words, it gives
rise to a random key falling into this bucket. See key::Key::for_distance
.
sourcepub fn iter(&'a self) -> impl Iterator<Item = EntryRefView<'a, TKey, TVal>>
pub fn iter(&'a self) -> impl Iterator<Item = EntryRefView<'a, TKey, TVal>>
Returns an iterator over the entries in the bucket.
Auto Trait Implementations§
impl<'a, TKey, TVal> RefUnwindSafe for KBucketRef<'a, TKey, TVal>where TKey: RefUnwindSafe, TVal: RefUnwindSafe,
impl<'a, TKey, TVal> Send for KBucketRef<'a, TKey, TVal>where TKey: Send, TVal: Send,
impl<'a, TKey, TVal> Sync for KBucketRef<'a, TKey, TVal>where TKey: Sync, TVal: Sync,
impl<'a, TKey, TVal> Unpin for KBucketRef<'a, TKey, TVal>
impl<'a, TKey, TVal> !UnwindSafe for KBucketRef<'a, TKey, TVal>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more