Add missing docs; rename linked lists to lists since they are not lin…

…ked anymore

README.md

@@ -114,7 +114,7 @@ for res in db.iter() {
 
 assert_eq!(db.iter().count(), 0);
 
-// list API ("linked lists")
+// lists API
 
 db.set_in_list("mylist", "key1", "123")?;
 db.set_in_list("mylist", "key2", "456")?;
@@ -160,7 +160,7 @@ existing element requires two IOs, since it needs to compare the key before writ
 These IOs may return from the kernel's page cache, in which case it's practically immediate, or from disk,
 in which case you can expect it to take 1-2 round-trip times of your device.
 
-Inserting to/removing from a linked-lists require 2-3 IOs, since these operations need to update the list's 
+Inserting to/removing from a lists require 2-3 IOs, since these operations need to update the list's 
 head or tail, as well as link/unlink to their previous element. Such operations should really be done with a "large enough page cache". 
 Updating/fetching an existing element element in a list is a single IO as above.
 

candy-perf/README.md

@@ -37,7 +37,7 @@ Performance results from my machine
   Large entries removal: 0.139us
 ```
 
-### Linked-lists
+### Lists
 ```
 10 collections with 100000 items in each
   Inserts: 8.104us

src/lib.rs

@@ -13,7 +13,7 @@
 //! table of ~380KB is kept `mmap`-ed (it is also file-backed, so can be evicted if needed). A shard-file can
 //! hold around 30K entries, and more shard-files are created as needed.
 //!
-//! A unique feature of Candy is the support of *linked lists*, which allow creating cheap collections.
+//! A unique feature of Candy is the support of *lists*, which allow creating cheap collections.
 //!
 //! Notes:
 //! * the file format is not yet stable!
@@ -30,7 +30,7 @@
 //!     db.remove("hello")?;
 //!     assert_eq!(db.get("hello")?, None);
 //!
-//!     // linked lists
+//!     // lists
 //!     db.set_in_list("italian", "bye", "arrivederci")?;
 //!     db.set_in_list("italian", "thanks", "grazie")?;
 //!     assert_eq!(db.get_from_list("italian", "bye")?, Some("arrivederci".into()));
@@ -57,7 +57,7 @@ mod typed;
 
 pub use hashing::HashSeed;
 pub use insertion::{GetOrCreateStatus, ReplaceStatus, SetStatus};
-pub use lists::{LinkedListIterator, ListCompactionParams};
+pub use lists::{ListCompactionParams, ListIterator};
 use std::fmt::{Display, Formatter};
 pub use store::{CandyStore, CoarseHistogram, SizeHistogram, Stats};
 pub use typed::{CandyTypedDeque, CandyTypedKey, CandyTypedList, CandyTypedStore};
@@ -75,7 +75,6 @@ pub enum CandyError {
     CompactionFailed(String),
     SplitFailed(String),
     LoadingFailed(String),
-    CorruptedLinkedList(String),
 }
 
 impl Display for CandyError {
@@ -88,7 +87,6 @@ impl Display for CandyError {
             Self::EntryCannotFitInShard(sz, max) => {
                 write!(f, "entry too big ({sz}) for a single shard file ({max})")
             }
-            Self::CorruptedLinkedList(s) => write!(f, "corrupted linked list: {s}"),
             Self::CompactionFailed(s) => write!(f, "shard compaction failed: {s}"),
             Self::LoadingFailed(s) => write!(f, "loading store failed: {s}"),
             Self::SplitFailed(s) => write!(f, "shard split failed: {s}"),