feat: add default transaction functions

Author: peeeuzin

src/collection/mod.rs

@@ -24,7 +24,7 @@ pub enum TransactionStatus {
 
 pub const COLLECTION_LOCK_FILE: &str = ".lock";
 
-#[derive(Clone)]
+/// Collection is a key-value store
 pub struct Collection<T: ValueTrait> {
     btree: Arc<Mutex<BTree<String, T>>>,
     xlog: Arc<Mutex<XLog<T>>>,
@@ -54,7 +54,7 @@ impl<T: ValueTrait> Collection<T> {
         })
     }
 
-    /// Starts a new transaction
+    /// Starts a new branch transaction.
     pub fn branch_start(&self) -> Result<impl Transaction<T> + '_> {
         let dustdata_config = dustdata_config();
         let base_path = dustdata_config.data_path.join(self.name.clone());

src/collection/strategies/branch.rs

@@ -1,13 +1,10 @@
 use std::fs;
 
 use crate::{
-    btree::{spec::BTreePair, BTree, BTreeIterator, ValueTrait},
-    collection::{
-        xact::{Transaction, TransactionOperations},
-        xlog::XLogOperation,
-    },
+    btree::{BTree, ValueTrait},
+    collection::xact::{Transaction, TransactionOperations},
     dustdata_config,
-    error::{Error, Result},
+    error::Error,
 };
 
 pub struct BranchTransaction<T: ValueTrait> {
@@ -18,50 +15,6 @@ pub struct BranchTransaction<T: ValueTrait> {
 }
 
 impl<T: ValueTrait> Transaction<T> for BranchTransaction<T> {
-    fn get(&mut self, key: &str) -> Result<Option<T>> {
-        self.btree.get(&key.to_string())
-    }
-
-    fn insert(&mut self, key: &str, value: T) -> Result<()> {
-        self.xact_op.write(XLogOperation::Insert {
-            key: key.to_string(),
-            value: value.clone(),
-        })?;
-
-        self.btree.insert(key.to_string(), value)
-    }
-
-    fn delete(&mut self, key: &str) -> Result<()> {
-        self.xact_op.write(XLogOperation::Delete {
-            key: key.to_string(),
-        })?;
-
-        self.btree.delete(&key.to_string())
-    }
-
-    fn update(&mut self, key: &str, new_value: T) -> Result<()> {
-        self.xact_op.write(XLogOperation::Update {
-            key: key.to_string(),
-            new_value: new_value.clone(),
-        })?;
-
-        self.btree.delete(&key.to_string())?;
-        self.btree.insert(key.to_string(), new_value)?;
-
-        Ok(())
-    }
-
-    fn iter(&mut self) -> BTreeIterator<'_, String, T> {
-        self.btree.iter()
-    }
-
-    fn find_by_pattern<'a>(
-        &'a mut self,
-        pattern: &'a str,
-    ) -> Box<(dyn Iterator<Item = BTreePair<String, T>> + 'a)> {
-        Box::new(self.btree.find_pattern(pattern))
-    }
-
     fn rollback(self) {}
 
     fn xid(&self) -> u64 {
@@ -71,6 +24,10 @@ impl<T: ValueTrait> Transaction<T> for BranchTransaction<T> {
     fn log(&mut self) -> &mut TransactionOperations<T> {
         &mut self.xact_op
     }
+
+    fn btree(&mut self) -> &mut BTree<String, T> {
+        &mut self.btree
+    }
 }
 
 impl<T: ValueTrait> Drop for BranchTransaction<T> {

src/collection/strategies/lock.rs

@@ -1,13 +1,10 @@
 use std::{fs, sync::MutexGuard};
 
 use crate::{
-    btree::{spec::BTreePair, BTree, BTreeIterator, ValueTrait},
-    collection::{
-        xact::{Transaction, TransactionOperations},
-        xlog::XLogOperation,
-    },
+    btree::{BTree, ValueTrait},
+    collection::xact::{Transaction, TransactionOperations},
     dustdata_config,
-    error::{Error, Result},
+    error::Error,
 };
 
 pub struct LockTransaction<'lock, T: ValueTrait> {
@@ -19,50 +16,6 @@ pub struct LockTransaction<'lock, T: ValueTrait> {
 }
 
 impl<'lock, T: ValueTrait> Transaction<T> for LockTransaction<'lock, T> {
-    fn get(&mut self, key: &str) -> Result<Option<T>> {
-        self.btree.get(&key.to_string())
-    }
-
-    fn insert(&mut self, key: &str, value: T) -> Result<()> {
-        self.xact_op.write(XLogOperation::Insert {
-            key: key.to_string(),
-            value: value.clone(),
-        })?;
-
-        self.btree.insert(key.to_string(), value)
-    }
-
-    fn delete(&mut self, key: &str) -> Result<()> {
-        self.xact_op.write(XLogOperation::Delete {
-            key: key.to_string(),
-        })?;
-
-        self.btree.delete(&key.to_string())
-    }
-
-    fn update(&mut self, key: &str, new_value: T) -> Result<()> {
-        self.xact_op.write(XLogOperation::Update {
-            key: key.to_string(),
-            new_value: new_value.clone(),
-        })?;
-
-        self.btree.delete(&key.to_string())?;
-        self.btree.insert(key.to_string(), new_value)?;
-
-        Ok(())
-    }
-
-    fn iter(&mut self) -> BTreeIterator<'_, String, T> {
-        self.btree.iter()
-    }
-
-    fn find_by_pattern<'a>(
-        &'a mut self,
-        pattern: &'a str,
-    ) -> Box<(dyn Iterator<Item = BTreePair<String, T>> + 'a)> {
-        Box::new(self.btree.find_pattern(pattern))
-    }
-
     fn rollback(self) {}
 
     fn xid(&self) -> u64 {
@@ -72,6 +25,10 @@ impl<'lock, T: ValueTrait> Transaction<T> for LockTransaction<'lock, T> {
     fn log(&mut self) -> &mut TransactionOperations<T> {
         &mut self.xact_op
     }
+
+    fn btree(&mut self) -> &mut BTree<String, T> {
+        &mut self.btree
+    }
 }
 
 impl<'a, T: ValueTrait> Drop for LockTransaction<'a, T> {

src/collection/xact.rs

@@ -42,18 +42,57 @@ impl<T: ValueTrait> TransactionOperations<T> {
 }
 
 pub trait Transaction<T: ValueTrait> {
-    fn get(&mut self, key: &str) -> Result<Option<T>>;
-    fn insert(&mut self, key: &str, value: T) -> Result<()>;
-    fn delete(&mut self, key: &str) -> Result<()>;
-    fn update(&mut self, key: &str, new_value: T) -> Result<()>;
-    fn iter(&mut self) -> BTreeIterator<'_, String, T>;
+    fn get(&mut self, key: &str) -> Result<Option<T>> {
+        self.btree().get(&key.to_string())
+    }
+
+    fn insert(&mut self, key: &str, value: T) -> Result<()> {
+        self.log().write(XLogOperation::Insert {
+            key: key.to_string(),
+            value: value.clone(),
+        })?;
+
+        self.btree().insert(key.to_string(), value)
+    }
+
+    fn delete(&mut self, key: &str) -> Result<()> {
+        self.log().write(XLogOperation::Delete {
+            key: key.to_string(),
+        })?;
+
+        self.btree().delete(&key.to_string())
+    }
+
+    fn update(&mut self, key: &str, new_value: T) -> Result<()> {
+        self.log().write(XLogOperation::Update {
+            key: key.to_string(),
+            new_value: new_value.clone(),
+        })?;
+
+        self.btree().delete(&key.to_string())?;
+        self.btree().insert(key.to_string(), new_value)?;
+
+        Ok(())
+    }
+
+    fn iter(&mut self) -> BTreeIterator<'_, String, T> {
+        self.btree().iter()
+    }
+
     fn find_by_pattern<'a>(
         &'a mut self,
         pattern: &'a str,
-    ) -> Box<dyn Iterator<Item = BTreePair<String, T>> + 'a>;
+    ) -> Box<(dyn Iterator<Item = BTreePair<String, T>> + 'a)>
+    where
+        T: 'a,
+    {
+        Box::new(self.btree().find_pattern(pattern))
+    }
+
     fn rollback(self);
     fn xid(&self) -> u64;
     fn log(&mut self) -> &mut TransactionOperations<T>;
+    fn btree(&mut self) -> &mut BTree<String, T>;
 }
 
 pub struct TransactionBuilder;

src/lib.rs

@@ -105,13 +105,35 @@ impl DustData {
         Ok(Self)
     }
 
+    /// Creates a new collection.
+    /// ## Arguments
+    /// * `name` - The name of the collection.
+    /// ## Example
+    /// ```rust
+    /// use dustdata::DustData;
+    ///
+    /// let dustdata = DustData::new().unwrap();
+    ///
+    /// let collection = dustdata.create_collection::<User>("users").unwrap();
+    /// ```
     pub fn collection<T>(&self, name: &str) -> Result<Arc<collection::Collection<T>>>
     where
         T: Sync + Send + Clone + Debug + Serialize + DeserializeOwned + 'static + Ord,
     {
         Ok(Arc::new(collection::Collection::new(name)?))
     }
 
+    /// Drops a collection.
+    /// ## Arguments
+    /// * `name` - The name of the collection.
+    /// ## Example
+    /// ```rust
+    /// use dustdata::DustData;
+    ///
+    /// let dustdata = DustData::new().unwrap();
+    ///
+    /// dustdata.drop_collection("users").unwrap();
+    /// ```
     pub fn drop_collection(&self, name: &str) -> Result<()> {
         let dustdata_config = dustdata_config();