refactor: update 'new' parameter to use 'impl AsRef<Path>' instead of…

… '&Path' for flexibility

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "userdmp"
-version = "0.1.0"
+version = "0.1.1"
 edition = "2021"
 description = "A library in Rust for parsing Minidump (.dmp) files generated in user mode on Windows"
 license = "MIT"

README.md

@@ -48,14 +48,11 @@ The userdmp library provides tools to parse and analyze Minidump (.dmp) files ge
 
 To start working with a Minidump file, use the `UserDump::new` function to parse the file and create a `UserDump` instance:
 ```rust, ignore
-use std::path::Path;
 use userdmp::{UserDump, UserDmpError};
 
 fn main() -> Result<(), UserDmpError> {
-    let path = Path::new("example.dmp");
-
     // Parse the Minidump file
-    let dump = UserDump::new(path)?;
+    let dump = UserDump::new("example.dmp")?;
     println!("Minidump parsed successfully!");
 
     Ok(())

examples/handles/src/main.rs

@@ -1,9 +1,7 @@
-use std::path::Path;
 use userdmp::{error::UserDmpError, UserDump};
 
 fn main() -> Result<(), UserDmpError> {
-    let path = Path::new("C:\\Examples.dmp");
-    let dmp = UserDump::new(path)?;
+    let dmp = UserDump::new("C:\\Examples.dmp")?;
 
     for(_, handle) in dmp.handles() {
         println!("Handle: {}", handle.handle());

examples/memorys/src/main.rs

@@ -1,9 +1,7 @@
-use std::path::Path;
 use userdmp::{error::UserDmpError, UserDump};
 
 fn main() -> Result<(), UserDmpError> {
-    let path = Path::new("C:\\Examples.dmp");
-    let dmp = UserDump::new(path)?;
+    let dmp = UserDump::new("C:\\Examples.dmp")?;
 
     for(_, memory) in dmp.memorys() {
         println!("Start: {}", memory.start_addr());

examples/modules/src/main.rs

@@ -1,9 +1,7 @@
-use std::path::Path;
 use userdmp::{error::UserDmpError, UserDump};
 
 fn main() -> Result<(), UserDmpError> {
-    let path = Path::new("C:\\Examples.dmp");
-    let dmp = UserDump::new(path)?;
+    let dmp = UserDump::new("C:\\Examples.dmp")?;
 
     for (_, module) in dmp.modules().iter() {
         println!("[*] Path: {:?}", module.path);

examples/system/src/main.rs

@@ -1,9 +1,7 @@
-use std::path::Path;
 use userdmp::{error::UserDmpError, UserDump};
 
 fn main() -> Result<(), UserDmpError> {
-    let path = Path::new("C:\\Examples.dmp");
-    let dmp = UserDump::new(path)?;
+    let dmp = UserDump::new("C:\\Examples.dmp")?;
     let system = dmp.system;
 
     println!("Number Of Processors: {}", system.number_of_processors);

examples/threads/src/main.rs

@@ -1,9 +1,7 @@
-use std::path::Path;
 use userdmp::{error::UserDmpError, UserDump};
 
 fn main() -> Result<(), UserDmpError> {
-    let path = Path::new("C:\\Examples.dmp");
-    let dmp = UserDump::new(path)?;
+    let dmp = UserDump::new("C:\\Examples.dmp")?;
 
     for (tid, thread) in dmp.threads().iter() {
         println!("[*] TID: {:?}", tid);

src/mapper.rs

@@ -45,7 +45,7 @@ impl<'a> MappingFile<'a> {
     ///     Ok(())
     /// }
     /// ```
-    pub fn new(path: &Path) -> Result<Self, UserDmpError> {
+    pub fn new(path: impl AsRef<Path>) -> Result<Self, UserDmpError> {
         let file = File::open(path)?;
         let (buffer, address) = mapper::map_file(file)?;
         Ok(Self { buffer, address })

src/parse.rs

@@ -98,10 +98,10 @@ impl<'a> UserDump<'a> {
     ///     Err(e) => eprintln!("Failed to parse minidump: {:?}", e),
     /// }
     /// ```
-    pub fn new(path: &Path) -> Result<Self, UserDmpError> {
+    pub fn new(path: impl AsRef<Path>) -> Result<Self, UserDmpError> {
         // Mapping the file in memory to the target environment (Windows or Linux).
         let mapped_file = MappingFile::new(path)?;
-        Self::parser(mapped_file)
+        Self::parse(mapped_file)
     }
 
     /// Returns a reference to the list of threads in the parsed minidump.
@@ -211,7 +211,7 @@ impl<'a> UserDump<'a> {
     /// 
     /// * `Ok(Self)` - If the file is parsed successfully.
     /// * `Err(UserDmpError)` - If the file format is invalid or if parsing fails.
-    fn parser(mapped_file: MappingFile<'a>) -> Result<Self, UserDmpError> {
+    fn parse(mapped_file: MappingFile<'a>) -> Result<Self, UserDmpError> {
         // Creates a cursor to navigate the mapped file.
         let mut cursor = mapped_file.cursor();