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
29
30
31
32

//! # The MemTable Prelude
//!
//! The memtable library comes with a variety of tools to help with building,
//! parsing, and transforming tables. While these could be brought in via a
//! mixture of `use memtable::*;` and other imports, this prelude serves as
//! the one-stop shop to import required traits, common structs, and more
//! without polluting the namespace with public modules exposed by this crate.
//!
//! # Prelude contents
//!
//! The current version of the prelude re-exports the following:
//!
//! * [`DynamicTable`] struct, which is a table that can grow and shrink dynamically
//! * [`FixedTable`] struct - available with Rust 1.51+ - provides a fixed-sized
//!   counterpart to [`DynamicTable`] where the table is pre-allocated internally
//!   using a 2D array
//! * [`FixedRowTable`] struct, where the total rows is fixed and columns
//!   can grow dynamically
//! * [`FixedColumnTable`] struct, where the total columns is fixed and rows
//!   can grow dynamically
//! * [`Table`] trait, which provides the majority of the methods
//!   available to operate on a table
//! * [`iter::CellIter`] trait, which enables examining the row & column
//!   positions of iterators over individual cells in a table as well as zip
//!   an iterator with the position of each cell
//! * [`list::List`] trait, which enables operations on a generic list of items
//! * [`list::DynamicList`] struct, which is a generic list that is able to
//!   grow and shrink dynamically without any bounds
//! * [`list::FixedList`] struct, which is a generic list that is able to grow
//!   and shrink within a limited bounds
//!
pub use crate::{impls::*, iter::CellIter, list::*, Table};