Batch insertion (#5)

- Refactor constructors, use `Builder` and `GenericBuilder` to construct WALs
- Support atomic batch insertion

.codecov.yml

@@ -7,12 +7,11 @@ ignore:
   - "**/benches/"
   - "src/tests.rs"
   - "src/error.rs"
-  - "src/swmr/generic/traits/impls/"
-  - "src/swmr/generic/traits/impls.rs"
   - "src/swmr/generic/tests.rs"
   - "src/swmr/generic/tests/"
   - "src/swmr/wal/tests.rs"
   - "src/swmr/wal/tests/"
+  - "src/wal/type/"
   - "src/unsync/tests.rs"
   - "src/unsync/tests/"
 

Cargo.toml

@@ -1,11 +1,11 @@
 [package]
 name = "orderwal"
-version = "0.1.1"
+version = "0.2.1"
 edition = "2021"
 repository = "https://github.com/al8n/orderwal"
 homepage = "https://github.com/al8n/orderwal"
 documentation = "https://docs.rs/orderwal"
-description = "A generic-purpose, ordered, zero-copy, Write-Ahead Log implementation for Rust."
+description = "A generic-purpose, atomic, ordered, zero-copy, Write-Ahead Log implementation for Rust."
 license = "MIT OR Apache-2.0"
 rust-version = "1.80"
 categories = ["filesystem", "database-implementations", "development-tools", "data-structures"]
@@ -34,6 +34,7 @@ thiserror = "1"
 
 bytes = { version = "1", default-features = false, optional = true }
 smallvec = { version = "1", default-features = false, optional = true, features = ["const_generics"] }
+smallvec-wrapper = { version = "0.1", optional = true, default-features = false, features = ["const_generics"] }
 smol_str = { version = "0.3", default-features = false, optional = true }
 faststr = { version = "0.2", default-features = false, optional = true }
 

README.md

@@ -3,7 +3,7 @@
 </div>
 <div align="center">
 
-A generic-purpose, ordered, zero-copy, Write-Ahead Log implementation for Rust.
+A generic-purpose, atomic, ordered, zero-copy, Write-Ahead Log implementation for Rust.
 
 [<img alt="github" src="https://img.shields.io/badge/github-al8n/orderwal-8da0cb?style=for-the-badge&logo=Github" height="22">][Github-url]
 <img alt="LoC" src="https://img.shields.io/endpoint?url=https%3A%2F%2Fgist.githubusercontent.com%2Fal8n%2F327b2a8aef9003246e45c6e47fe63937%2Fraw%2Forderwal" height="22">
@@ -21,17 +21,21 @@ English | [简体中文][zh-cn-url]
 
 ## Introduction
 
-`orderwal` is a generic-purpose, ordered, zero-copy, concurrent-safe, pre-allocate style (memory map) write-ahead-log for developing databases.
+`orderwal` is generic-purpose, atomic, ordered, zero-copy, concurrent-safe, pre-allocate style (memory map) write-ahead-log for developing databases.
 
 `orderwal` also supports generic structured key and value types, which is not limited to just bytes like other implementations.
 
 ## Installation
 
 ```toml
 [dependencies]
-orderwal = "0.1"
+orderwal = "0.2"
 ```
 
+## Example
+
+See [examples](./examples/) for more information.
+
 ## Related projects
 
 - [`aol`](https://github.com/al8n/aol): Yet another generic purpose, append-only write-ahead log implementation based on `std::fs::File`.
@@ -44,7 +48,7 @@ Apache License (Version 2.0).
 
 See [LICENSE-APACHE](LICENSE-APACHE), [LICENSE-MIT](LICENSE-MIT) for details.
 
-Copyright (c) 2021 Al Liu.
+Copyright (c) 2024 Al Liu.
 
 [Github-url]: https://github.com/al8n/orderwal/
 [CI-url]: https://github.com/al8n/orderwal/actions/workflows/ci.yml

examples/zero_cost.rs

@@ -1,6 +1,10 @@
 use std::{cmp, sync::Arc, thread::spawn};
 
-use orderwal::{swmr::generic::*, utils::*, OpenOptions, Options};
+use orderwal::{
+  swmr::generic::{Comparable, Equivalent, GenericBuilder, KeyRef, Type, TypeRef},
+  utils::*,
+  OpenOptions,
+};
 
 #[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord)]
 struct Person {
@@ -112,7 +116,7 @@ impl Type for Person {
 }
 
 impl<'a> TypeRef<'a> for PersonRef<'a> {
-  fn from_slice(src: &'a [u8]) -> Self {
+  unsafe fn from_slice(src: &'a [u8]) -> Self {
     let (id_size, id) = decode_u64_varint(src).unwrap();
     let name = std::str::from_utf8(&src[id_size..]).unwrap();
     PersonRef { id, name }
@@ -132,15 +136,15 @@ fn main() {
     .collect::<Vec<_>>();
 
   let mut wal = unsafe {
-    GenericOrderWal::<Person, String>::map_mut(
-      &path,
-      Options::new(),
-      OpenOptions::new()
-        .create_new(Some(1024 * 1024))
-        .write(true)
-        .read(true),
-    )
-    .unwrap()
+    GenericBuilder::new()
+      .map_mut::<Person, String, _>(
+        &path,
+        OpenOptions::new()
+          .create_new(Some(1024 * 1024))
+          .write(true)
+          .read(true),
+      )
+      .unwrap()
   };
 
   // Create 100 readers

src/buffer.rs

@@ -14,13 +14,22 @@ macro_rules! builder {
         impl<F> [< $name Builder >]<F> {
           #[doc = "Creates a new `" [<$name Builder>] "` with the given size and builder closure."]
           #[inline]
-          pub const fn new<E>(size: $size, f: F) -> Self
+          pub const fn once<E>(size: $size, f: F) -> Self
           where
             F: for<'a> FnOnce(&mut VacantBuffer<'a>) -> Result<(), E>,
           {
             Self { size, f }
           }
 
+          #[doc = "Creates a new `" [<$name Builder>] "` with the given size and builder closure."]
+          #[inline]
+          pub const fn new<E>(size: $size, f: F) -> Self
+          where
+            F: for<'a> Fn(&mut VacantBuffer<'a>) -> Result<(), E>,
+          {
+            Self { size, f }
+          }
+
           #[doc = "Returns the required" [< $name: snake>] "size."]
           #[inline]
           pub const fn size(&self) -> $size {