docs(example): clean up get example

examples/get.rs

@@ -10,6 +10,8 @@
 /// `example-readme.md` in the current directory.
 use std::path::Path;
 
+use kxio::fs::FileHandle;
+
 #[tokio::main]
 async fn main() -> kxio::Result<()> {
     // Create a `Net` object for making real network requests.
@@ -27,7 +29,7 @@ async fn main() -> kxio::Result<()> {
     let file_path = fs.base().join("example-readme.md");
 
     // Create a generic handle for the file. This doesn't open the file, and always succeeds.
-    let path: kxio::fs::PathReal<kxio::fs::PathMarker> = fs.path(&file_path);
+    let path = fs.path(&file_path);
 
     // Other options are;
     // `fs.file(&file_path)` - for a file
@@ -35,17 +37,16 @@ async fn main() -> kxio::Result<()> {
 
     // Checks if the path exists (whether a file, directory, etc)
     if path.exists()? {
-        // extracts the path from the handle
+        eprintln!("The file {path} already exists. Aborting!");
-        let pathbuf = path.as_pathbuf();
-        eprintln!("The file {} already exists. Aborting!", pathbuf.display());
         return Ok(());
     }
 
     // Passes a reference to the `fs` and `net` objects for use by your program.
     // Your programs should not know whether they are handling a mock or the real thing.
     // Any file or network access should be made using these handlers to be properly testable.
-    download_and_save_to_file(url, &file_path, &fs, &net).await?;
+    let file = download_and_save_to_file(url, &file_path, &fs, &net).await?;
-    delete_file(&file_path, &fs)?;
+    read_file(&file)?;
+    delete_file(file)?;
 
     Ok(())
 }
@@ -58,42 +59,33 @@ async fn download_and_save_to_file(
     fs: &kxio::fs::FileSystem,
     // The network abstraction
     net: &kxio::net::Net,
-) -> kxio::Result<()> {
+) -> kxio::Result<FileHandle> {
     println!("fetching: {url}");
 
-    // Rather than calling `.build().send()?` on the request, pass it to the `net`
+    // Makes a GET request that can be mocked in a test
-    // This allows the `net` to either make the network request as normal, or, if we are
+    let response: reqwest::Response = net.get(url).header("key", "value").send().await?;
-    // under test, to handle the request as the test dictates.
+
-    // NOTE: if the `.build().send()` is called on the `request` then that WILL result in
+    // As you can see, we use [reqwest] under the hood.
-    // a real network request being made, even under test conditions. Only ever use the
-    // `net.send(...)` function to keep your code testable.
-    // `kxio::net::Response` is an alias for `reqwest::Response`.
-    let response: kxio::net::Response = net.get(url).header("key", "value").send().await?;
-    // Other options:
-    //   Uses the network abstraction to create a perfectly normal `reqwest::ResponseBuilder`.
-    //   `kxio::net::RequestBuilder` is an alias.
-    // let response = net.send(net.client().get(url)).await?;
     //
-    // let response = net.post(url).body("{}").send().await?;
+    // If you need to create a more complex request than the [kxio] fluent API allows, you
+    // can create a request using [reqwest] and pass it to [net.send(request)].
 
     let body = response.text().await?;
     println!("fetched {} bytes", body.bytes().len());
 
-    println!("writing file: {}", file_path.display());
     // Uses the file system abstraction to create a handle for a file.
     let file: kxio::fs::PathReal<kxio::fs::FileMarker> = fs.file(file_path);
+    println!("writing file: {file}");
     // Writes the body to the file.
     file.write(body)?;
 
-    Ok(())
+    Ok(file)
 }
 
-/// An function that uses a `FileSystem` object to interact with the outside world.
+/// A function that reads the file contents
-fn delete_file(file_path: &Path, fs: &kxio::fs::FileSystem) -> kxio::Result<()> {
+fn read_file(file: &FileHandle) -> kxio::Result<()> {
-    println!("reading file: {}", file_path.display());
+    println!("reading file: {file}");
 
-    // Uses the file system abstraction to create a handle for a file.
-    let file: kxio::fs::PathReal<kxio::fs::FileMarker> = fs.file(file_path);
     // Creates a `Reader` which loaded the file into memory.
     let reader: kxio::fs::Reader = file.reader()?;
     let contents: &str = reader.as_str();
@@ -102,6 +94,15 @@ fn delete_file(file_path: &Path, fs: &kxio::fs::FileSystem) -> kxio::Result<()>
     Ok(())
 }
 
+/// A function that deletes the file
+fn delete_file(file: FileHandle) -> kxio::Result<()> {
+    println!("deleting file: {file}");
+
+    file.remove()?;
+
+    Ok(())
+}
+
 #[cfg(test)]
 mod tests {
     use http::StatusCode;

src/fs/dir.rs

@@ -1,3 +1,5 @@
+use std::fmt::Display;
+
 //
 use crate::fs::{DirItem, DirItemIterator, Result};
 
@@ -106,3 +108,9 @@ impl TryFrom<PathHandle<PathMarker>> for DirHandle {
         }
     }
 }
+
+impl Display for DirHandle {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        write!(f, "{}/", self.as_pathbuf().display())
+    }
+}

src/fs/file.rs

@@ -1,7 +1,9 @@
+use std::fmt::Display;
+
 //
 use crate::fs::Result;
 
-use super::{reader::Reader, Error, FileHandle, PathHandle, PathMarker};
+use super::{reader::Reader, Error, FileHandle, FileMarker, PathHandle, PathMarker, PathReal};
 
 impl FileHandle {
     /// Returns a [Reader] for the file.
@@ -112,3 +114,9 @@ impl TryFrom<PathHandle<PathMarker>> for FileHandle {
         }
     }
 }
+
+impl Display for PathReal<FileMarker> {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        write!(f, "{}", self.as_pathbuf().display())
+    }
+}

src/fs/path.rs

@@ -1,5 +1,6 @@
 //
 use std::{
+    fmt::Display,
     marker::PhantomData,
     path::{Path, PathBuf},
 };
@@ -367,3 +368,9 @@ impl From<FileHandle> for PathHandle<PathMarker> {
         PathReal::new(file.base, file.path)
     }
 }
+
+impl Display for PathReal<PathMarker> {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        write!(f, "{}", self.as_pathbuf().display())
+    }
+}

src/net/system.rs

@@ -97,6 +97,9 @@ impl Net {
     /// then the request will be matched and any stored response returned, or an
     /// error if no matched request was found.
     ///
+    /// This method provides an escape-hatch from `kxio`'s fluent API, and allows you
+    /// to create a request using [reqwest] directly.
+    ///
     /// # Errors
     ///
     /// This method fails if there was an error while sending request,

tests/fs.rs

@@ -16,6 +16,14 @@ mod path {
 
         assert_eq!(read.base(), fs.base());
     }
+
+    #[test]
+    fn display() {
+        let fs = fs::temp().expect("temp fs");
+        let path = fs.base().join("foo");
+        let path_handle = fs.path(&path);
+        assert_eq!(path_handle.to_string(), format!("{}", path.display()));
+    }
     mod is_link {
         use super::*;
 
@@ -456,20 +464,13 @@ mod path {
 mod file {
     use super::*;
 
-    // // test for reading the symlink metadata
+    #[test]
-    // #[test]
+    fn display() {
-    // fn symlink_metadata() -> TestResult {
+        let fs = fs::temp().expect("temp fs");
-    //     let fs = fs::temp().expect("temp fs");
+        let path = fs.base().join("foo");
-    //     let file_path = fs.base().join("foo");
+        let file_handle = fs.file(&path);
-    //     let file = fs.file(&file_path);
+        assert_eq!(file_handle.to_string(), format!("{}", path.display()));
-    //     file.write("bar").expect("write");
+    }
-    //     let link_path = fs.base().join("bar");
-    //     let link = fs.path(&link_path);
-    //     file.soft_link(&link).expect("soft_link");
-    //     let md = link.symlink_metadata().expect("symlink metadata");
-    //     assert!(md.is_file());
-    //     Ok(())
-    // }
 
     #[test]
     fn create_hard_link() -> TestResult {
@@ -793,6 +794,14 @@ mod dir {
 
         use super::*;
 
+        #[test]
+        fn display() {
+            let fs = fs::temp().expect("temp fs");
+            let path = fs.base().join("foo");
+            let dir_handle = fs.dir(&path);
+            assert_eq!(dir_handle.to_string(), format!("{}/", path.display()));
+        }
+
         #[test]
         fn path_is_dir() {
             let fs = fs::temp().expect("temp fs");