Tracking PR for write-functionality branch

.vscode/settings.json

@@ -2,5 +2,6 @@
     "[rust]": {
         "editor.defaultFormatter": "rust-lang.rust-analyzer",
         "editor.formatOnSave": true
-    }
+    },
+    "rust-analyzer.check.command": "clippy",
 }

Cargo.toml

@@ -16,10 +16,11 @@ log = "0.4.22"
 serde = { version = "1.0.204", default-features = false, features = [ "alloc", "derive" ] }
 serde-big-array = "0.5.1"
 time = { version = "0.3.36", default-features = false, features = [ "alloc", "parsing", "macros" ]}
+typed-path = { version = "0.10.0", default-features = false }
 
 [features]
 default = ["std"]
-std = ["displaydoc/std", "serde/std", "time/std"]
+std = ["time/std", "time/local-offset"]
 
 [dev-dependencies]
 test-log = "0.2.16"

README.md

@@ -29,13 +29,13 @@ A fully-working FAT driver that covers the following criteria:
 
 - [x] FAT12 support (just handle entries between 2 sectors)
 - [x] Distinguish between dirs and files in paths (this must also be verified by the filesystem, just like in the `std`)
-- [ ] Check whether system endianness matters (FAT is little-endian)
+- [x] Check whether system endianness matters (FAT is little-endian)
+    PS: it does in fact matter. [bincode](https://crates.io/crates/bincode), which we use for (de)serialization allows us to configure the default endianess
 - [ ] Handle non-printable characters in names of files and directories
 - [ ] ExFAT support
-- [ ] when [feature(error_in_core)](https://github.com/rust-lang/rust/issues/103765) gets released to stable, bump MSRV & use the `core::error::Error` trait instead of our custom `error::Error`
-
-[crates.io]: https://crates.io
-[rafalh's rust-fatfs]: https://github.com/rafalh/rust-fatfs
+- [x] ~~when [feature(error_in_core)](https://github.com/rust-lang/rust/issues/103765) gets released to stable, bump MSRV & use the `core::error::Error` trait instead of our custom `error::Error`~~
+    this feature is now stabilized. However, [after a couple of community recommendations](https://www.reddit.com/r/rust/comments/1ejukow/comment/lgg3dtb/), we will be switching to [embedded-io] in the near future, which has its own `Error` trait, so that means...
+- [ ] replace custom `io` implementation with the [embedded-io] crate
 
 ## Acknowledgements
 
@@ -44,3 +44,7 @@ This project adheres to [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
 ## License
 
 [MIT](LICENSE)
+
+[crates.io]: https://crates.io
+[rafalh's rust-fatfs]: https://github.com/rafalh/rust-fatfs
+[embedded-io]: https://crates.io/crates/embedded-io

imgs/fat12.img.check

@@ -1 +1 @@
-ec293f4087abbd287e6024fc7918836de91ced075428f15688b9fb2462733990 *imgs/fat12.img
+d591b06414897e425d4cd02550d22b60ff1b3c16d1dca3fdff532a115eefa47f *imgs/fat12.img

imgs/fat16.img.check

@@ -1 +1 @@
-4eddf671476c0ac64ca0ae3bf8837e07515082f89975ddd2ff43113fde521558 *imgs/fat16.img
+894fe3973c733f6a1e2e86661a5ba40c84f926bfd3710b655b49bebd0d22246d *imgs/fat16.img

imgs/fat32.img.check

@@ -1 +1 @@
-604b7fdf8131868241dc4f33817994838f0da4d9795d400c0120e460cf7897e1 *imgs/fat32.img
+5e49c78dfcf001666926151f1a95df991f91729016cc3949fc589702604d2a5f *imgs/fat32.img

src/error.rs

@@ -1,7 +1,4 @@
-#[cfg(not(feature = "std"))]
-use core::*;
-#[cfg(feature = "std")]
-use std::*;
+use core::fmt;
 
 /// Base error type
 ///
@@ -51,6 +48,8 @@ pub trait IOErrorKind: PartialEq + Sized {
     fn new_interrupted() -> Self;
     /// Create a new `InvalidData` [`IOErrorKind`]
     fn new_invalid_data() -> Self;
+    /// Create a new `Unsupported` [`IOErrorKind`]
+    fn new_unsupported() -> Self;
 
     #[inline]
     /// Check whether this [`IOErrorKind`] is of kind `UnexpectedEOF`
@@ -67,6 +66,11 @@ pub trait IOErrorKind: PartialEq + Sized {
     fn is_invalid_data(&self) -> bool {
         self == &Self::new_invalid_data()
     }
+    /// Check whether this [`IOErrorKind`] is of kind `Unsupported`
+    #[inline]
+    fn is_unsupported(&self) -> bool {
+        self == &Self::new_unsupported()
+    }
 }
 
 #[cfg(feature = "std")]
@@ -83,6 +87,10 @@ impl IOErrorKind for std::io::ErrorKind {
     fn new_invalid_data() -> Self {
         std::io::ErrorKind::InvalidData
     }
+    #[inline]
+    fn new_unsupported() -> Self {
+        std::io::ErrorKind::Unsupported
+    }
 }
 
 /// An error type that denotes that there is something wrong
@@ -95,11 +103,20 @@ pub enum InternalFSError {
     InvalidBPBSig,
     /**
      Invalid FAT32 FSInfo signature.
-     Perhaps the FSInfo structure or the FAT32 EBR's fat_info field is malformed?
+     Perhaps the FSInfo structure or the FAT32 Ebr's fat_info field is malformed?
     */
     InvalidFSInfoSig,
+    /**
+     The FAT and it's copies do not much.
+     This is either the result of some bad FAT library that chose to ignore the FAT copies
+     or perhaps the storage medium has been corrupted (most likely).
+     Either way, we are not handling this FileSystem
+    */
+    MismatchingFATTables,
     /// Encountered a malformed cluster chain
     MalformedClusterChain,
+    /// Encountered a malformed directory entry chain
+    MalformedEntryChain,
 }
 
 /// An error indicating that a filesystem-related operation has failed
@@ -112,7 +129,7 @@ where
     #[displaydoc("An internal FS error occured: {0}")]
     InternalFSError(InternalFSError),
     /**
-     The [PathBuf](`crate::path::PathBuf`) provided is malformed.
+     The [Path](`crate::Path`) provided is malformed.
 
      This is mostly an error variant used for internal testing.
      If you get this error, open an issue: <https://github.com/Oakchris1955/simple-fatfs/issues>
@@ -129,6 +146,10 @@ where
     NotADirectory,
     /// Found a directory when we expected a file
     IsADirectory,
+    /// Expected an empty directory
+    DirectoryNotEmpty,
+    /// This file cannot be modified, as it is read-only
+    ReadOnlyFile,
     /// A file or directory wasn't found
     NotFound,
     /// An IO error occured