Crate radixmap

Expand description

radixmap

This crate is a rust-based radix tree implementation. Radix tree, also known as Trie, is a space-optimized tree data structure for efficient information retrieval. Its key advantages are space optimization, fast prefix-based searches, and efficient memory usage. Radix trees are widely used, especially in HTTP routers.

§Features

Fast prefix-based lookup
RadixMap and RadixSet support
Standard collection-compatible interfaces
Named param, glob, regex support
Pre-order, post-order, level-order iterations
Comprehensive unit tests for correctness

§Example

use bytes::Bytes;
use radixmap::{RadixMap, RadixResult};

fn main() -> RadixResult<()> {
    let mut map = RadixMap::new();
    map.insert("/api", "api")?;
    map.insert("/api/v1", "v1")?;
    map.insert("/api/v1/user", "user1")?;
    map.insert("/api/v2", "v2")?;
    map.insert("/api/v2/user", "user2")?;

    assert_eq!(map.get(b"/api/v1/user"), Some(&"user1"));
    assert_eq!(map.get(b"/api/v2/user"), Some(&"user2"));

    let mut iter = map.iter(); // pre-order by default

    assert_eq!(iter.next(), Some((&Bytes::from("/api"), &"api")));
    assert_eq!(iter.next(), Some((&Bytes::from("/api/v1"), &"v1")));
    assert_eq!(iter.next(), Some((&Bytes::from("/api/v1/user"), &"user1")));
    assert_eq!(iter.next(), Some((&Bytes::from("/api/v2"), &"v2")));
    assert_eq!(iter.next(), Some((&Bytes::from("/api/v2/user"), &"user2")));
    assert_eq!(iter.next(), None);

    Ok(())
}

Re-exports§

pub use map::RadixMap;
pub use set::RadixSet;
pub use defs::RadixError;
pub use defs::RadixResult;

Modules§

defs
Common defines
map
Radix map implementation
node
Node is the core tree element
pack
Pack represents a node’s children
rule
Rule represents a match
set
Radix set implementation

Macros§