debug: add debug implementation for file-related structs

Author: phip1611

CHANGELOG.md

@@ -17,6 +17,7 @@
 - Added partial support for the TCG protocols for TPM devices under `uefi::proto::tcg`.
 - Added the `unsafe_protocol` macro to provide a slightly nicer way to
   implement protocols.
+- `FileType`, `FileHandle`, `RegularFile`, and `Directory` now implement `Debug`.
 
 ### Changed
 

uefi/src/proto/media/file/dir.rs

@@ -2,6 +2,7 @@ use super::{File, FileHandle, FileInfo, FromUefi, RegularFile};
 use crate::data_types::Align;
 use crate::Result;
 use core::ffi::c_void;
+use core::fmt::{Debug, Formatter};
 #[cfg(feature = "alloc")]
 use {crate::mem::make_boxed, alloc::boxed::Box};
 #[cfg(all(feature = "unstable", feature = "alloc"))]
@@ -125,6 +126,12 @@ impl Directory {
     }
 }
 
+impl Debug for Directory {
+    fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result {
+        f.debug_tuple("Directory").field(&self.0).finish()
+    }
+}
+
 impl File for Directory {
     #[inline]
     fn handle(&mut self) -> &mut FileHandle {

uefi/src/proto/media/file/mod.rs

@@ -13,7 +13,7 @@ mod regular;
 use crate::{CStr16, Char16, Guid, Result, Status};
 use bitflags::bitflags;
 use core::ffi::c_void;
-use core::fmt::Debug;
+use core::fmt::{Debug, Formatter};
 use core::mem;
 use core::ptr;
 #[cfg(all(feature = "unstable", feature = "alloc"))]
@@ -304,6 +304,17 @@ impl File for FileHandle {
     }
 }
 
+impl Debug for FileHandle {
+    fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result {
+        f.debug_struct("FileHandle")
+            .field("is_regular_file", &self.is_regular_file().unwrap_or(false))
+            .field("is_directory", &self.is_directory().unwrap_or(false))
+            // We can't print the info, as fetching info requires &mut self.
+            .field("info", &"<hidden>")
+            .finish()
+    }
+}
+
 impl Drop for FileHandle {
     fn drop(&mut self) {
         let result: Result = (self.imp().close)(self.imp()).into();
@@ -365,7 +376,8 @@ pub(super) struct FileImpl {
     flush: extern "efiapi" fn(this: &mut FileImpl) -> Status,
 }
 
-/// Disambiguates the file type. Returned by `File::into_type()`.
+/// Disambiguate the file type. Returned by `File::into_type()`.
+#[derive(Debug)]
 pub enum FileType {
     /// The file was a regular (data) file.
     Regular(RegularFile),

uefi/src/proto/media/file/regular.rs

@@ -1,5 +1,6 @@
 use super::{File, FileHandle, FileInternal};
 use crate::{Result, Status};
+use core::fmt::{Debug, Formatter};
 
 /// A `FileHandle` that is also a regular (data) file.
 ///
@@ -115,6 +116,12 @@ impl RegularFile {
     }
 }
 
+impl Debug for RegularFile {
+    fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result {
+        f.debug_tuple("RegularFile").field(&self.0).finish()
+    }
+}
+
 impl File for RegularFile {
     #[inline]
     fn handle(&mut self) -> &mut FileHandle {