Mercurial > lbo > hg > leveldb-rs

changeset 141:ad36c0aba2f2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add doc comment to TableFooter
author Lewin Bormann <lbo@spheniscida.de>
date Mon, 02 Jan 2017 15:42:18 +0100
parents 3ae8a50f1b7d
children 06c8d65b6367
files src/table_builder.rs
diffstat 1 files changed, 4 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/src/table_builder.rs	Mon Jan 02 15:30:40 2017 +0100
+++ b/src/table_builder.rs	Mon Jan 02 15:42:18 2017 +0100
@@ -29,6 +29,10 @@
     pub index: BlockHandle,
 }
 
+/// A Table footer contains a pointer to the metaindex block, another pointer to the index block,
+/// and a magic number:
+/// [ { table data ... , METAINDEX blockhandle, INDEX blockhandle, PADDING bytes } = 40 bytes,
+/// MAGIC_FOOTER_ENCODED ]
 impl Footer {
     pub fn new(metaix: BlockHandle, index: BlockHandle) -> Footer {
         Footer {