add doc for block cache

fjall-rs · Dec 9, 2023 · 47ebd82 · 47ebd82
1 parent 5327744
commit 47ebd82
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 4 deletions.
diff --git a/examples/actix-kv/Cargo.toml b/examples/actix-kv/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "actix-kv"
-version = "1.0.0"
+version = "0.0.1"
 edition = "2021"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

diff --git a/examples/actix-triplestore/Cargo.toml b/examples/actix-triplestore/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "actix-triplestore"
-version = "0.1.0"
+version = "0.0.1"
 edition = "2021"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

diff --git a/examples/structured/Cargo.toml b/examples/structured/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "structured"
-version = "0.1.0"
+version = "0.0.1"
 edition = "2021"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

diff --git a/src/block_cache.rs b/src/block_cache.rs
@@ -13,7 +13,10 @@ use std::sync::Arc;
 type Key = (u8, String, UserKey);
 type Item = Either<Arc<ValueBlock>, Arc<BlockHandleBlock>>;
 
-/// Block cache
+/// Block cache, in which blocks are cached in-memory
+/// after being retrieved from disk. This speeds up
+/// consecutive queries to nearby data, improving read
+/// performance for hot data.
 ///
 /// # Examples
 ///