kermit-iters 0.0.1-dev

Kermit, the Leapfrog Triejoin algorithm with associated data structures
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

use crate::linear::LinearIterator;

/// Trie iterator trait
pub trait TrieIterator<KT: PartialOrd + PartialEq + Clone>: LinearIterator<KT> {
    /// If there is a non-root node at the iterator's current position which has
    /// children, positions the iterator at the first child and returns a
    /// reference to the key. Otherwise, returns None.
    ///
    /// # Note
    /// If the iterator is positioned at the end, then this functions as if
    /// the iterator is positioned at the previous node.
    fn open(&mut self) -> Option<&KT>;

    /// If there is a non-root node at the iterator's current position,
    /// positions the iterator at its parent and returns a reference to the key
    /// if it is a non-root Node.
    /// Otherwise, returns None.
    ///
    /// # Note
    /// If the iterator is positioned at the end, then this functions as if
    /// the iterator is positioned at the previous node.
    fn up(&mut self) -> Option<&KT>;
}

/// Trie iterable trait
pub trait TrieIterable<KT: PartialOrd + PartialEq + Clone> {
    fn trie_iter(&self) -> impl TrieIterator<KT>;
}