fs: add and export constant COMMON_SKIP_DIRS

Author: phip1611

uefi/src/fs/dir_entry_iter.rs

@@ -1,8 +1,12 @@
 //! Module for directory iteration. See [`UefiDirectoryIter`].
 
 use super::*;
-use crate::Result;
+use crate::{CStr16, Result};
 use alloc::boxed::Box;
+use uefi_macros::cstr16;
+
+/// Common skip dirs in UEFI/FAT-style file systems.
+pub const COMMON_SKIP_DIRS: &[&CStr16] = &[cstr16!("."), cstr16!("..")];
 
 /// Iterates over the entries of an UEFI directory. It returns boxed values of
 /// type [`UefiFileInfo`].
@@ -14,6 +18,7 @@ pub struct UefiDirectoryIter(UefiDirectoryHandle);
 
 impl UefiDirectoryIter {
     /// Constructor.
+    #[must_use]
     pub fn new(handle: UefiDirectoryHandle) -> Self {
         Self(handle)
     }

uefi/src/fs/file_system/fs.rs

@@ -11,8 +11,6 @@ use core::fmt;
 use core::fmt::{Debug, Formatter};
 use core::ops::Deref;
 use log::debug;
-use uefi::CStr16;
-use uefi_macros::cstr16;
 
 /// Return type for public [`FileSystem`] operations.
 pub type FileSystemResult<T> = Result<T, Error>;
@@ -186,13 +184,12 @@ impl<'a> FileSystem<'a> {
     /// Removes a directory at this path, after removing all its contents. Use
     /// carefully!
     pub fn remove_dir_all(&mut self, path: impl AsRef<Path>) -> FileSystemResult<()> {
-        const SKIP_DIRS: [&CStr16; 2] = [cstr16!("."), cstr16!("..")];
         let path = path.as_ref();
         for file_info in self
             .read_dir(path)?
             .filter_map(|file_info_result| file_info_result.ok())
         {
-            if SKIP_DIRS.contains(&file_info.file_name()) {
+            if COMMON_SKIP_DIRS.contains(&file_info.file_name()) {
                 continue;
             }
 

uefi/src/fs/mod.rs

@@ -35,8 +35,8 @@ mod file_system;
 mod path;
 mod uefi_types;
 
+pub use dir_entry_iter::*;
 pub use file_system::*;
 pub use path::*;
 
-use dir_entry_iter::*;
 use uefi_types::*;