Skip to content

Commit b6c414e

Browse files
committed
docstring for Value
1 parent f593c69 commit b6c414e

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

src/store.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,12 @@ pub enum Operation {
2323
Remove,
2424
}
2525

26+
/// Value for the store, associated to a key.
27+
///
28+
/// This is a simple wrapper around a [`Vec<u8>`] which represent any value that
29+
/// can be (de)serialised into a [`LogEntry`].
30+
///
31+
/// TODO: Can this be better represented as a generic, rather than a "new type"?
2632
#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)]
2733
pub struct Value(pub Option<Vec<u8>>);
2834

0 commit comments

Comments
 (0)