fix: lints+formatting+docs

Author: alexcu2718

clippy_test.sh

@@ -32,4 +32,5 @@ cargo clippy --all -- \
   -A clippy::absolute_paths \
   -A clippy::let_underscore_untyped \
   -A clippy::missing_docs_in_private_items \
-  -A clippy::items_after_statements
+  -A clippy::items_after_statements \
+  -A clippy::mod_module_files

src/config.rs

@@ -109,7 +109,7 @@ pub struct SearchConfig {
 }
 impl SearchConfig {
     /**
-    Constructor for SearchConfig
+    Constructor for `SearchConfig`
 
     Builds a regex matcher if a valid pattern is provided, otherwise stores None
     Returns an error if the regex compilation fails

src/filters/time_filter.rs

@@ -3,11 +3,8 @@ use clap::{
     builder::{PossibleValue, TypedValueParser},
     error::{ContextKind, ContextValue, ErrorKind},
 };
-use std::{
-    ffi::OsStr,
-    fmt,
-    time::{Duration, SystemTime},
-};
+use core::time::Duration;
+use std::{ffi::OsStr, fmt, time::SystemTime};
 
 #[derive(Debug, Clone, PartialEq, Eq)]
 #[allow(clippy::exhaustive_enums)]
@@ -61,7 +58,7 @@ pub enum TimeFilter {
 
 impl TimeFilter {
     /**
-     Parses a time string and returns a `TimeFilter`
+     Parses a time string and returns a `TimeFilter`.
 
      # Arguments
 
@@ -75,6 +72,24 @@ impl TimeFilter {
      - `..` separator: between two times (e.g., "2d..1d" = files modified between 2 days and 1 day ago)
      - Supported units: s (seconds), m (minutes), h (hours), d (days), w (weeks), y (years)
 
+     # Examples
+
+     ```
+     use fdf::filters::TimeFilter;
+
+     // Files modified within the last hour
+     let filter = TimeFilter::from_string("-1h").unwrap();
+
+     // Files modified more than 2 days ago
+     let filter = TimeFilter::from_string("+2d").unwrap();
+
+     // Files modified between 2 days and 1 day ago
+     let filter = TimeFilter::from_string("2d..1d").unwrap();
+     ```
+
+     # Errors
+
+     Returns `ParseTimeError::InvalidFormat` if the string cannot be parsed or is in an invalid format.
     */
     pub fn from_string(s: &str) -> Result<Self, ParseTimeError> {
         Self::parse_args(s).ok_or(ParseTimeError::InvalidFormat)

src/fs/buffer.rs

@@ -178,8 +178,7 @@ where
     #[cfg(any(target_os = "linux", target_os = "android"))]
     pub fn getdents(&mut self, fd: &crate::fs::FileDes) -> i64 {
         // SAFETY: we're passing a valid buffer
-        unsafe {
-            crate::util::getdents(fd.0, self.as_mut_ptr(), SIZE) }
+        unsafe { crate::util::getdents(fd.0, self.as_mut_ptr(), SIZE) }
     }
 
     // TODO: Maybe delete this?

src/fs/iter.rs

@@ -503,8 +503,8 @@ pub trait DirentConstructor {
         This allows no dynamic resizing during iteration, which is costly!
          */
 
-        // SAFETY: write is within buffer bounds
         #[allow(clippy::multiple_unsafe_ops_per_block)] //dumb
+        // SAFETY: write is within buffer bounds
         unsafe {
             *path_buffer.as_mut_ptr().add(base_len) = b'/' * (!is_root as u8) // add slash if needed  (this avoids a branch )
         };

src/util/glob.rs

@@ -61,6 +61,7 @@ use std::vec::IntoIter as VecIntoIter;
 /// Error type for glob pattern operations
 #[allow(clippy::error_impl_error)]
 #[derive(Debug)]
+#[non_exhaustive]
 pub enum Error {
     /// Bare escape at the end of the pattern
     BareEscape,

src/util/utils.rs

@@ -1,8 +1,8 @@
 use crate::dirent64;
-use crate::{util::memchr_derivations::memrchr};
+use crate::util::memchr_derivations::memrchr;
 use core::ops::Deref;
 
-/*
+/**
   Wrapper for direct getdents syscalls
 
 

src/walk/finder.rs

@@ -5,7 +5,7 @@ use crate::{
     walk::{DirEntryFilter, FilterType, finder_builder::FinderBuilder},
 };
 use dashmap::DashSet;
-use rayon::iter::{IntoParallelIterator, ParallelIterator};
+use rayon::iter::{IntoParallelIterator as _, ParallelIterator as _};
 use std::{
     ffi::OsStr,
     sync::{

src/walk/finder_builder.rs

@@ -207,6 +207,7 @@ impl FinderBuilder {
     }
 
     /// Set how many threads rayon is to use, defaults to max
+    #[must_use]
     pub const fn thread_count(mut self, threads: Option<usize>) -> Self {
         match threads {
             Some(num) => self.thread_count = num,