Mercurial > lbo > hg > sstable
changeset 17:14b6aad53465
Update TableBuilder documentation
| author | Lewin Bormann <lbo@spheniscida.de> |
|---|---|
| date | Tue, 22 Nov 2016 21:25:50 +0100 |
| parents | 99181f6b5b24 |
| children | 186231a15135 |
| files | src/table_builder.rs |
| diffstat | 1 files changed, 8 insertions(+), 6 deletions(-) [+] |
line wrap: on
line diff
--- a/src/table_builder.rs Tue Nov 22 21:15:19 2016 +0100 +++ b/src/table_builder.rs Tue Nov 22 21:25:50 2016 +0100 @@ -78,13 +78,15 @@ /// A table consists of DATA BLOCKs, an INDEX BLOCK and a FOOTER. /// -/// DATA BLOCKs, INDEX BLOCK BLOCK are built using the code in -/// the `block` module. +/// DATA BLOCKs, INDEX BLOCKs, and BLOCKs are built using the code in the `block` module. /// -/// The footer is a pointer pointing to -/// the index block, padding to fill up to 40 B and at the end the 8B magic number -/// 0xdb4775248b80fb57. - +/// DATA BLOCKs contain the actual data; INDEX BLOCKS contain one entry per block, where the key is +/// a string after the last key of a block, and the value is a encoded BlockHandle pointing to that +/// block. +/// +/// The footer is a pointer pointing to the index block, padding to fill up to 40 B and at the end +/// the 8B magic number 0xdb4775248b80fb57. +/// pub struct TableBuilder<C: Comparator, Dst: Write> { o: BuildOptions, cmp: C,