feat(api): rename some structs

Author: KSXGitHub

src/app.rs

@@ -215,14 +215,12 @@ impl App {
             SizeGetter::Size: Send + Sync + 'static,
             SizeGetter::Reporter: crate::reporter::Reporter<SizeGetter::Size>,
         {
-            type Hook = hook::RecordHardLink<'static, Self::Size>;
-            fn create_hook(record: &'static hook::RecordHardLinkStorage<Self::Size>) -> Self::Hook {
-                hook::RecordHardLink::new(record)
+            type Hook = hook::RecordHardlink<'static, Self::Size>;
+            fn create_hook(record: &'static hook::HardlinkList<Self::Size>) -> Self::Hook {
+                hook::RecordHardlink::new(record)
             }
-            fn init_hardlink_record() -> &'static hook::RecordHardLinkStorage<Self::Size> {
-                hook::RecordHardLinkStorage::new()
-                    .pipe(Box::new)
-                    .pipe(Box::leak)
+            fn init_hardlink_record() -> &'static hook::HardlinkList<Self::Size> {
+                hook::HardlinkList::new().pipe(Box::new).pipe(Box::leak)
             }
         }
 

src/app/sub.rs

@@ -187,13 +187,13 @@ pub trait DeduplicateHardlinkSizes<Size: size::Size> {
 }
 
 #[cfg(unix)]
-impl<'a, Size> DeduplicateHardlinkSizes<Size> for hook::RecordHardLink<'a, Size>
+impl<'a, Size> DeduplicateHardlinkSizes<Size> for hook::RecordHardlink<'a, Size>
 where
     DataTree<OsStringDisplay, Size>: Send,
     Size: size::Size + Sync,
 {
-    type HardlinkRecord = &'a hook::RecordHardLinkStorage<Size>;
-    type DeduplicationReport = &'a hook::RecordHardLinkStorage<Size>;
+    type HardlinkRecord = &'a hook::HardlinkList<Size>;
+    type DeduplicationReport = &'a hook::HardlinkList<Size>;
 
     fn deduplicate_hardlink_sizes(
         data_tree: &mut DataTree<OsStringDisplay, Size>,

src/hook.rs

@@ -41,6 +41,6 @@ impl<Size, Reporter> Hook<Size, Reporter> for DoNothing {
 #[cfg(unix)]
 pub mod record_hardlink;
 #[cfg(unix)]
-pub use record_hardlink::RecordHardLink;
+pub use record_hardlink::HardlinkList;
 #[cfg(unix)]
-pub use record_hardlink::RecordHardLinkStorage;
+pub use record_hardlink::RecordHardlink;

src/hook/record_hardlink.rs

@@ -1,6 +1,6 @@
 pub mod storage;
 
-pub use storage::RecordHardLinkStorage;
+pub use storage::HardlinkList;
 
 use super::{Hook, HookArgument};
 use crate::{
@@ -12,19 +12,19 @@ use std::{fmt::Debug, os::unix::fs::MetadataExt};
 
 /// A [hook](Hook) that record files with more than 1 links.
 #[derive(Debug, Clone, Copy)]
-pub struct RecordHardLink<'a, Size> {
+pub struct RecordHardlink<'a, Size> {
     /// Map an inode number to its size and detected paths.
-    storage: &'a RecordHardLinkStorage<Size>,
+    storage: &'a HardlinkList<Size>,
 }
 
-impl<'a, Size> RecordHardLink<'a, Size> {
+impl<'a, Size> RecordHardlink<'a, Size> {
     /// Create a [hook](Hook) to record files with more than 1 links.
-    pub fn new(storage: &'a RecordHardLinkStorage<Size>) -> Self {
-        RecordHardLink { storage }
+    pub fn new(storage: &'a HardlinkList<Size>) -> Self {
+        RecordHardlink { storage }
     }
 }
 
-impl<'a, Size, Report> Hook<Size, Report> for RecordHardLink<'a, Size>
+impl<'a, Size, Report> Hook<Size, Report> for RecordHardlink<'a, Size>
 where
     Size: size::Size + Eq + Debug,
     Report: Reporter<Size> + ?Sized,

src/hook/record_hardlink/storage.rs

@@ -4,17 +4,17 @@ use derive_more::{Display, Error};
 use pipe_trait::Pipe;
 use std::{fmt::Debug, path::Path};
 
-/// Storage to be used by [`crate::hook::RecordHardLink`].
+/// Storage to be used by [`crate::hook::RecordHardlink`].
 #[derive(Debug, Clone)]
-pub struct RecordHardLinkStorage<Size>(
+pub struct HardlinkList<Size>(
     /// Map an inode number to its size and detected paths.
     DashMap<InodeNumber, (Size, LinkPathList)>, // TODO: benchmark against Mutex<HashMap<InodeNumber, (Size, LinkPathList)>>
 );
 
-impl<Size> RecordHardLinkStorage<Size> {
+impl<Size> HardlinkList<Size> {
     /// Create a new record.
     pub fn new() -> Self {
-        RecordHardLinkStorage(DashMap::new())
+        HardlinkList(DashMap::new())
     }
 
     /// Iterate over the recorded entries.
@@ -23,9 +23,9 @@ impl<Size> RecordHardLinkStorage<Size> {
     }
 }
 
-impl<Size> Default for RecordHardLinkStorage<Size> {
+impl<Size> Default for HardlinkList<Size> {
     fn default() -> Self {
-        RecordHardLinkStorage::new()
+        HardlinkList::new()
     }
 }
 
@@ -39,15 +39,15 @@ pub struct SizeConflictError<Size> {
     pub detected: Size,
 }
 
-/// Error that occurs when it fails to add an item to [`RecordHardLinkStorage`].
+/// Error that occurs when it fails to add an item to [`RecordHardlinkStorage`].
 #[derive(Debug, Display, Error)]
 #[display(bound(Size: Debug))]
 #[non_exhaustive]
 pub enum AddError<Size> {
     SizeConflict(SizeConflictError<Size>),
 }
 
-impl<Size> RecordHardLinkStorage<Size>
+impl<Size> HardlinkList<Size>
 where
     Size: size::Size,
 {
@@ -78,7 +78,7 @@ where
     }
 }
 
-/// Iterator over entries in [`RecordHardLinkStorage`].
+/// Iterator over entries in [`RecordHardlinkStorage`].
 #[derive(derive_more::Debug)]
 #[debug(bound())]
 #[debug("Iter(..)")]