kermit-iters 0.0.8

Iterators used in Kermit
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

//! This module defines the `Joinable` trait, which is used to specify types
//! that can be joined.

/// The `Joinable` trait is used to specify types that can be joined.
///
/// # Note
/// While having a deceptively simple definition, this trait plays a crucial
/// role in unifying data structures found in the `kermit_iters` crate with the
/// algorithms of `kermit_algos`. It can be viewed as a sort of bridging type.
///
/// Each iterator defined in `kermit_iters` has an associated trait that extends
/// `Joinable`. For the `LinearIterator`, it is the trait `LinearIterable`,
/// which defines the `linear_iter` method returning something that implements
/// the `LinearIterator`. For the `TrieIterator`, it is the trait
/// `TrieIterable`, which defines the `trie_iter` method returning something
/// that implements the `TrieIterator`.
///
/// On the data structure side, all things that conform to the `Relation` trait
/// must implement `Joinable`. In the case of `TreeTrie`, `TrieIterable`
/// is implemented. TODO: Complete this
pub trait JoinIterable {}