docs: more details

Author: KSXGitHub

src/hardlink/hardlink_list.rs

@@ -29,9 +29,9 @@ struct Value<Size> {
 
 /// Storage to be used by [`crate::hardlink::RecordHardlinks`].
 ///
-/// **Serialization and deserialization:** _(feature: `json`)_ `HardlinkList` does not implement
-/// `Serialize` and `Deserialize` traits directly, instead, it can be converted into/from a
-/// [`Reflection`] which implements these traits.
+/// **Reflection:** `HardlinkList` does not implement `PartialEq`, `Eq`, `Hash`,
+/// `Deserialize`, and `Serialize` directly. Instead, it can be converted into a
+/// [`Reflection`] which implement these traits.
 #[derive(Debug, SmartDefault, Clone)]
 pub struct HardlinkList<Size>(
     /// Map an inode number to its size, number of links, and detected paths.

src/hardlink/hardlink_list/reflection.rs

@@ -11,8 +11,11 @@ use serde::{Deserialize, Serialize};
 /// [`HardlinkList`]'s internal content.
 ///
 /// **Guarantees:**
+/// * Every inode number is unique.
 /// * The internal list is always sorted by inode numbers.
 ///
+/// **Equality and identity:** `Reflection` implements `PartialEq`, `Eq`, and `Hash` traits.
+///
 /// **Serialization and deserialization:** _(feature: `json`)_ `Reflection` implements
 /// `Serialize` and `Deserialize` traits, this allows functions in `serde_json` to convert
 /// a `Reflection` into/from JSON.

src/hardlink/link_path_list.rs

@@ -10,9 +10,10 @@ use std::path::PathBuf;
 
 /// List of different hardlinks to the same file.
 ///
-/// **Serialization and deserialization:** _(feature: `json`)_ `LinkPathList` does not implement
-/// `Serialize` and `Deserialize` traits directly, instead, it can be converted into/from a
-/// [`Reflection`] which implements these traits.
+/// **Reflection:** `LinkPathList` does not implement `PartialEq`, `Eq`, `Hash`,
+/// `Deserialize`, and `Serialize` directly. Instead, it can be converted into a
+/// [`Reflection`] which implement these traits. Do note that the time complexity
+/// of such conversion is O(n) as it has to convert a `Vec` into a `HashSet`.
 #[derive(Debug, Clone)]
 pub struct LinkPathList(Vec<PathBuf>);
 

src/hardlink/link_path_list/reflection.rs

@@ -9,6 +9,8 @@ use serde::{Deserialize, Serialize};
 /// Intermediate format used for construction and inspection of
 /// [`LinkPathList`]'s internal content.
 ///
+/// **Equality and identity:** `Reflection` implements `PartialEq`, `Eq`, and `Hash` traits.
+///
 /// **Serialization and deserialization:** _(feature: `json`)_ `Reflection` implements
 /// `Serialize` and `Deserialize` traits, this allows functions in `serde_json` to convert
 /// a `Reflection` into/from JSON.