changeset 23:e1bf0485bc96

Add deprecation notice; -> 0.3.2
author Lewin Bormann <lbo@spheniscida.de>
date Mon, 02 Jan 2017 12:53:29 +0100
parents ae10f3dadcea
children cdfc2e935c8a
files Cargo.toml src/table_builder.rs
diffstat 2 files changed, 6 insertions(+), 5 deletions(-) [+]
line wrap: on
line diff
--- a/Cargo.toml	Wed Nov 23 21:37:22 2016 +0100
+++ b/Cargo.toml	Mon Jan 02 12:53:29 2017 +0100
@@ -1,7 +1,7 @@
 [package]
 name = "sstable"
-description = "Sorted String Tables, an on-disk format for storing immutable maps consisting of string,string pairs, and retrieving values by key efficiently."
-version = "0.3.1"
+description = "NOTE: This package is deprecated; it has some bugs that will not be fixed. If you want to publish a better crate under this name, please contact me and I'll transfer ownership! +++ Sorted String Tables, an on-disk format for storing immutable maps consisting of string,string pairs, and retrieving values by key efficiently."
+version = "0.3.2"
 readme = "README.md"
 keywords = ["sstable", "database"]
 repository = "https://bitbucket.org/dermesser/sstable"
--- a/src/table_builder.rs	Wed Nov 23 21:37:22 2016 +0100
+++ b/src/table_builder.rs	Mon Jan 02 12:53:29 2017 +0100
@@ -82,8 +82,9 @@
 ///
 /// DATA BLOCKs, INDEX BLOCKs, and BLOCKs are built using the code in the `block` module.
 ///
-/// 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
+/// DATA BLOCKs contain the actual data, and a footer of [4B crc32; 1B compression];
+/// 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
@@ -156,7 +157,7 @@
     }
 
     /// Writes an index entry for the current data_block where `next_key` is the first key of the
-    /// next block.
+    /// next block. Then, write the actual block to disk.
     fn write_data_block(&mut self, next_key: &[u8]) {
         assert!(self.data_block.is_some());