Struct Art

pub struct Art<K, V> { /* private fields */ }

Adaptive Radix Tree.

Radix tree is ordered according to key. Radix tree requires that key to be representable as comparable by sequence, e.g. key should implement Key trait which used to convert it to byte sequence.

This crate provides Key implementations for most commonly used data types:

• unsigned integers(u8, u16, u32, u64, u128)
• signed integers(i8, i16, i32, i64, i128)
• usize
• floating point numbers through Float32/Float64 types
• ByteString for raw byte sequences. It can be used for ASCII strings(UTF-8 strings not supported now, they require additional library to convert into comparable byte sequence).

Implementations

impl<K: Key, V> Art<K, V>

pub fn new() -> Self

Create empty [ART] tree.

pub fn insert(&mut self, key: K, value: V) -> bool

Insert key-value pair into tree.
Return true if key-value successfully inserted into tree, otherwise false if tree already contains same key.

pub fn upsert(&mut self, key: K, value: V)

Insert key-value pair into tree. If key already exists in tree, existing value will be replaced, otherwise inserts new KV into tree.

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

Remove value associated with key.
Returns Some(V) if key found in tree, otherwise None.

pub fn get(&self, key: &K) -> Option<&V>

Get value associated with key.
Returns Some(V) if key found in tree, otherwise None.

pub fn range( &self, range: impl RangeBounds<K>, ) -> impl DoubleEndedIterator<Item = (&K, &V)>

where K: Ord,

Execute tree range scan.

pub fn iter(&self) -> impl DoubleEndedIterator<Item = (&K, &V)>

where K: Ord,

Returns tree iterator.

Trait Implementations

impl<K: Key, V> Default for Art<K, V>

fn default() -> Self

Returns the “default value” for a type.