Module memtable_core::prelude[][src]

Expand description

Contains relevant top-level traits, structs, and more to make use of this library

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

Re-exports

pub use crate::iter::CellIter;
pub use crate::list::*;
pub use crate::Table;

Structs

Represents an inmemory table containing rows & columns of some data T, capable of growing and shrinking in size dynamically

FixedColumnTablealloc or std

Represents an inmemory table containing rows & columns of some data T with a fixed capacity across columns, but ability to grow dynamically with rows

FixedRowTablealloc or std

Represents an inmemory table containing rows & columns of some data T with a fixed capacity across rows, but ability to grow dynamically with columns

FixedTablealloc or std

Represents an inmemory table containing rows & columns of some data T with a fixed capacity across both rows and columns