🍋 Cargo doc friendly

Cargo.toml

@@ -1,27 +1,11 @@
 [package]
 name = "optimistic_lock_coupling"
-version = "0.2.0"
+version = "0.2.5"
 authors = ["lemonhx <lemonhx@lemonhx.tech>"]
 edition = "2018"
 description = "A General Lock following paper 'Optimistic Lock Coupling: A Scalable and Efficient General-Purpose Synchronization Method' "
 license = "Unlicense"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-[lib]
-name = "optimistic_lock_coupling"
-path = "src/lib.rs"
-
-[[bin]]
-name = "read_example"
-path = "example/read.rs"
-[[bin]]
-name = "write_example"
-path = "example/write.rs"
-[[bin]]
-name = "multi_thread_example"
-path = "example/multi_thread.rs"
-
-
 [[bench]]
 name = "benchmark"
 harness = false

example/multi_thread.rs

@@ -35,10 +35,8 @@ fn main() {
     use std::thread::spawn;
     let thread1 = spawn(write_fn);
     let thread2 = spawn(read_fn);
-    let thread3 = spawn(read_fn);
 
     let _ = thread1.join();
     let _ = thread2.join();
-    let _ = thread3.join();
     unsafe { assert_eq!(*(lock.as_ref().unwrap().write().unwrap()), i) }
 }

example/read.rs

@@ -17,14 +17,23 @@ fn read_txn(lock: &OptimisticLockCoupling<i32>) -> Result<(), OptimisticLockCoup
 fn main() {
     let lock = OptimisticLockCoupling::new(1);
     // retry steps
-    'retry: loop{
+    'retry: loop {
         // function call
         let res = read_txn(&lock);
         // before retry logics
         if res.is_err() {
             continue 'retry;
-        }else{
+        } else {
             break 'retry;
         }
     }
-}
+    // or
+    lock.read_txn(
+        #[inline(always)]
+        |guard| {
+            println!("{}", guard);
+            Ok(())
+        },
+    )
+    .unwrap();
+}