inverted_index_util/
lib.rs

1//! # inverted-index-util
2//!
3//! This crate provides utilities for implementing inverted indexes
4//!
5//! ## Usage
6//! ```rust
7//!     use inverted_index_util::entity_list::insert_entity_mut;
8//!     use typenum::consts::U16;
9//!     let mut entity_list: Vec<u8> = Vec::new();
10//!
11//!     insert_entity_mut::<U16>(&mut entity_list, b"aaaaaaaaaaaaaaaa");
12//!     insert_entity_mut::<U16>(&mut entity_list, b"cccccccccccccccc");
13//!     insert_entity_mut::<U16>(&mut entity_list, b"aaaaaaaaaaaaaaaa");
14//!     insert_entity_mut::<U16>(&mut entity_list, b"bbbbbbbbbbbbbbbb");
15//!
16//!     assert_eq!(
17//!         &entity_list[..],
18//!         &b"aaaaaaaaaaaaaaaabbbbbbbbbbbbbbbbcccccccccccccccc"[..]
19//!     );
20//! ```
21
22pub mod entity_list;