Struct llrb_index::Llrb

pub struct Llrb<K, V> where
    K: Clone + Ord,
    V: Clone,  { /* fields omitted */ }

Llrb manage a single instance of in-memory index using left-leaning-red-black tree.

Implementations

impl<K, V> Llrb<K, V> where
    K: Clone + Ord,
    V: Clone, 

Different ways to construct a new Llrb instance.

pub fn new<S>(name: S) -> Llrb<K, V> where
    S: AsRef<str>, 

Create an empty instance of Llrb, identified by name. Applications can choose unique names.

impl<K, V> Llrb<K, V> where
    K: Clone + Ord,
    V: Clone, 

Maintenance API.

pub fn id(&self) -> String

Identify this instance. Applications can choose unique names while creating Llrb instances.

pub fn len(&self) -> usize

Return number of entries in this instance.

pub fn is_empty(&self) -> bool

Check whether this index is empty.

pub fn stats(&self) -> Stats

Return quickly with basic statisics, only entries() method is valid with this statisics.

impl<K, V> Llrb<K, V> where
    K: Clone + Ord,
    V: Clone, 

Write operations on Llrb instance.

pub fn create(&mut self, key: K, value: V) -> Result<(), Error<K>>

Create a new {key, value} entry in the index. If key is already present return error.

pub fn set(&mut self, key: K, value: V) -> Option<V>

Set value for key. If there is an existing entry for key, overwrite the old value with new value and return the old value.

pub fn delete<Q: ?Sized>(&mut self, key: &Q) -> Option<V> where
    K: Borrow<Q>,
    Q: Ord, 

Delete key from this instance and return its value. If key is not present, then delete is effectively a no-op.

pub fn validate(&self) -> Result<Stats, Error<K>>

Validate LLRB tree with following rules:

• From root to any leaf, no consecutive reds allowed in its path.
• Number of blacks should be same under left child and right child.
• Make sure keys are in sorted order.

Additionally return full statistics on the tree. Refer to Stats for more information.

impl<K, V> Llrb<K, V> where
    K: Clone + Ord,
    V: Clone, 

Read operations on Llrb instance.

pub fn get<Q: ?Sized>(&self, key: &Q) -> Option<V> where
    K: Borrow<Q>,
    Q: Ord, 

Get the value for key.

pub fn random<R: Rng>(&self, rng: &mut R) -> Option<(K, V)>

Return a random entry from this index.

pub fn iter(&self) -> Iter<'_, K, V>

Return an iterator over all entries in this instance.

pub fn range<Q: ?Sized, R>(&self, range: R) -> Range<'_, K, V, R, Q> where
    K: Borrow<Q>,
    R: RangeBounds<Q>,
    Q: Ord, 

Range over all entries from low to high.

pub fn reverse<R, Q: ?Sized>(&self, range: R) -> Reverse<'_, K, V, R, Q> where
    K: Borrow<Q>,
    R: RangeBounds<Q>,
    Q: Ord, 

Reverse range over all entries from high to low.

Trait Implementations

impl<K: Clone, V: Clone> Clone for Llrb<K, V> where
    K: Clone + Ord,
    V: Clone, 

fn clone(&self) -> Llrb<K, V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K, V> Extend<(K, V)> for Llrb<K, V> where
    K: Clone + Ord,
    V: Clone, 

fn extend<I>(&mut self, iter: I) where
    I: IntoIterator<Item = (K, V)>, 

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.