high level fs abstraction WIP

Author: phip1611

Cargo.toml

@@ -27,6 +27,11 @@ logger = []
 # were observed on the VirtualBox UEFI implementation (see uefi-rs#121).
 # In those cases, this feature can be excluded by removing the default features.
 panic-on-logger-errors = []
+# high level FS abstraction
+fs = [
+    "alloc",
+    "exts"
+]
 
 [dependencies]
 bitflags = "1.3.1"

src/fs/file_system.rs

@@ -48,8 +48,9 @@ impl From<PathError> for FileSystemError {
 /// Return type for public [FileSystem] operations.
 pub type FileSystemResult<T> = Result<T, FileSystemError>;
 
-/// Entry point into the file system abstraction described by the module description. Accessor to
-/// an UEFI volume. Available methods try to be close to the `fs` module of `libstd`.
+/// The file system abstraction provided by this module. It acts as convenient accessor to an UEFI
+/// volume in top of the [`SimpleFileSystemProtocol`]. The available methods try to be close to the
+/// `fs` module from the Rust standard library.
 ///
 /// # Technical Background
 /// Some random interesting information how this abstraction helps.
@@ -63,7 +64,7 @@ pub struct FileSystem<'name, 'boot_services> {
 }
 
 impl<'name, 'boot_services> FileSystem<'name, 'boot_services> {
-    /// Constructor. The name is only used to help you as a user to identify this file system.
+    /// Constructor. The name is only used to help developers to identify this file system.
     /// This may be "root", "main", or "boot".
     pub fn new(
         name: &'name str,

src/fs/mod.rs

@@ -1,5 +1,5 @@
-//! A high-level file system API for UEFI applications. It supports you to conveniently perform the
-//! following important operations:
+//! A high-level file system API for UEFI applications. It supports developers to conveniently
+//! perform the following operations:
 //! - read file to bytes
 //! - write bytes to file
 //! - create files
@@ -19,9 +19,10 @@
 //! `&str` and validated internally. There are no `File` objects that are exposed to users.
 //!
 //! The difference to using the [SimpleFileSystemProtocol] directly is that the abstractions in this
-//! module take care of automatic release of resources and support you by returning data owned on
-//! the heap (such as file info). There is no synchronization as it is untypically that users
-//! bootstrap Application Processors (AP) during the UEFI stage, i.e., before hand-off to a kernel.
+//! module take care of automatic release of resources and support developers by returning data
+//! owned on the heap (such as file info). There is no synchronization as it is untypically that
+//! users bootstrap Application Processors (AP) during the UEFI stage, i.e., before hand-off to a
+//! kernel.
 
 mod dir_entry_iter;
 mod file_info;

src/lib.rs

@@ -64,5 +64,5 @@ pub mod alloc;
 #[cfg(feature = "logger")]
 pub mod logger;
 
-#[cfg(all(feature = "exts", feature = "alloc"))]
+#[cfg(feature = "fs")]
 pub mod fs;