doc: documents segmented_log::MetaWithIdx

arindas · arindas · May 24, 2024 · Dec 24, 2023 · Dec 24, 2023 · Dec 29, 2023
commit b70ba84c6de7950b87422a29ba4c938f7670f2f3
diff --git a/src/storage/commit_log/segmented_log/mod.rs b/src/storage/commit_log/segmented_log/mod.rs
@@ -127,16 +127,24 @@ use std::{
     time::Duration,
 };
 
+/// Represent metadata for records in the [`SegmentedLog`].
 #[derive(Debug, Clone, Copy, Serialize, Deserialize)]
 pub struct MetaWithIdx<M, Idx> {
+    /// Generic metadata for the record as necessary
     pub metadata: M,
+
+    /// Index of the record within the [`SegmentedLog`].
     pub index: Option<Idx>,
 }
 
 impl<M, Idx> MetaWithIdx<M, Idx>
 where
     Idx: Eq,
 {
+    /// Returns a [`Some`]`(`[`MetaWithIdx`]`)` containing this instance's `metadata` and the
+    /// provided `anchor_idx` if this indices match or this instance's `index` is `None`.
+    ///
+    /// Returns `None` if this instance contains an `index` and the indices mismatch.
     pub fn anchored_with_index(self, anchor_idx: Idx) -> Option<Self> {
         let index = match self.index {
             Some(idx) if idx != anchor_idx => None,
@@ -150,6 +158,8 @@ where
     }
 }
 
+/// Record type alias for [`SegmentedLog`] using [`MetaWithIdx`] for the generic metadata
+/// parameter.
 pub type Record<M, Idx, T> = super::Record<MetaWithIdx<M, Idx>, T>;
 
 #[derive(Debug)]