[][src]Struct libp2p_kad::kbucket::KBucketRef

pub struct KBucketRef<'a, TKey, TVal> { /* fields omitted */ }

A reference to a bucket in a KBucketsTable.

Implementations

impl<'a, TKey, TVal> KBucketRef<'a, TKey, TVal> where
    TKey: Clone + AsRef<KeyBytes>,
    TVal: Clone
[src]

pub fn range(&self) -> (Distance, Distance)[src]

Returns the minimum inclusive and maximum inclusive Distance for this bucket.

pub fn is_empty(&self) -> bool[src]

Checks whether the bucket is empty.

pub fn num_entries(&self) -> usize[src]

Returns the number of entries in the bucket.

pub fn has_pending(&self) -> bool[src]

Returns true if the bucket has a pending node.

pub fn contains(&self, d: &Distance) -> bool[src]

Tests whether the given distance falls into this bucket.

pub fn rand_distance(&self, rng: &mut impl Rng) -> Distance[src]

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.

pub fn iter(&'a self) -> impl Iterator<Item = EntryRefView<'a, TKey, TVal>>[src]

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

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,