docstring for Value

jdockerty · Apr 19, 2024 · 63b2ef4 · 63b2ef4
1 parent f593c69
commit 63b2ef4
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/src/store.rs b/src/store.rs
@@ -23,6 +23,12 @@ pub enum Operation {
     Remove,
 }
 
+/// Value for the store, associated to a key.
+///
+/// This is a simple wrapper around a [`Vec<u8>`] which represent any value that
+/// can be (de)serialised into a [`LogEntry`].
+///
+/// TODO: Can this be represented as a generic, rather than a "new type"?
 #[derive(Debug, Clone, Deserialize, Serialize, PartialEq)]
 pub struct Value(pub Option<Vec<u8>>);