Merge pull request #7 from nivalis-studio/refactor-string-path

Author: pnwatin

src/convert_file.rs

@@ -1,5 +1,6 @@
 extern crate rayon;
 use rayon::prelude::*;
+use std::path::Path;
 
 use anyhow::{Context, Result};
 
@@ -59,7 +60,7 @@ pub fn convert_file(
             .try_for_each(|(index, pointcloud)| -> Result<()> {
                 println!("Saving pointcloud {}...", index);
 
-                convert_pointcloud(index, pointcloud, &input_path, &output_path, &las_version)
+                convert_pointcloud(index, pointcloud, Path::new(&input_path), Path::new(&output_path), &las_version)
                     .context(format!("Error while converting pointcloud {}", index))?;
 
                 Ok(())
@@ -68,7 +69,7 @@ pub fn convert_file(
 
         save_stations(output_path, pointclouds)?;
     } else {
-        convert_pointclouds(e57_reader, &output_path, &las_version)
+        convert_pointclouds(e57_reader, Path::new(&output_path), &las_version)
             .context("Error during the parallel processing of pointclouds")?;
     }
     Ok(())

src/convert_pointcloud.rs

@@ -23,17 +23,24 @@ use rayon::prelude::*;
 ///
 /// # Example
 /// ```ignore
-/// use e57_to_las::convert_pointcloud;
-/// let pointcloud = e57::Pointcloud {  };
-/// let input_path = String::from("path/to/input.e57");
-/// let output_path = String::from("path/to/output");
-/// convert_pointcloud(0, &pointcloud, input_path, output_path);
+/// use std::path::Path;
+/// use e57_to_las::{convert_pointcloud, LasVersion};
+/// 
+/// # fn example() -> anyhow::Result<()> {
+/// let input_path = Path::new("path/to/input.e57");
+/// let output_path = Path::new("path/to/output");
+/// let las_version = LasVersion::new(1, 4)?;
+/// // pointcloud would be obtained from E57Reader in practice
+/// # let pointcloud = todo!();
+/// convert_pointcloud(0, &pointcloud, input_path, output_path, &las_version)?;
+/// # Ok(())
+/// # }
 /// ```
 pub fn convert_pointcloud(
     index: usize,
     pointcloud: &PointCloud,
-    input_path: &String,
-    output_path: &String,
+    input_path: &Path,
+    output_path: &Path,
     las_version: &LasVersion,
 ) -> Result<()> {
     let mut e57_reader = E57Reader::from_file(input_path).context("Failed to open e57 file: ")?;
@@ -69,7 +76,7 @@ pub fn convert_pointcloud(
     let max_cartesian = max_x.max(max_y).max(max_z);
 
     let path = create_path(
-        Path::new(&output_path)
+        output_path
             .join("las")
             .join(format!("{}{}", index, ".las")),
     )
@@ -104,14 +111,22 @@ pub fn convert_pointcloud(
 ///
 /// # Example
 /// ```ignore
-/// use e57_to_las::convert_pointclouds;
-/// let e57_reader = e57::E57Reader::from_file("path/to/input.e56").context("Failed to open e57 file")?;
-/// let output_path = String::from("path/to/output");
-/// convert_pointclouds(e57_reader, output_path);
+/// use std::path::Path;
+/// use e57_to_las::{convert_pointclouds, LasVersion};
+/// use anyhow::Context;
+/// 
+/// # fn example() -> anyhow::Result<()> {
+/// let input_path = Path::new("path/to/input.e57");
+/// let e57_reader = e57::E57Reader::from_file(input_path).context("Failed to open e57 file")?;
+/// let output_path = Path::new("path/to/output");
+/// let las_version = LasVersion::new(1, 4)?;
+/// convert_pointclouds(e57_reader, output_path, &las_version)?;
+/// # Ok(())
+/// # }
 /// ```
 pub fn convert_pointclouds(
     e57_reader: E57Reader<BufReader<File>>,
-    output_path: &String,
+    output_path: &Path,
     las_version: &LasVersion,
 ) -> Result<()> {
     let pointclouds = e57_reader.pointclouds();
@@ -164,7 +179,7 @@ pub fn convert_pointclouds(
         .context("Error while converting pointcloud")?;
 
     let path = create_path(
-        Path::new(&output_path)
+        output_path
             .join("las")
             .join(format!("{}{}", 0, ".las")),
     )