uefi: Revising style for EFI Shell CurDir functions

Co-authored-by: Nicholas Bishop <[email protected]>

Author: RenTrieu

uefi-test-runner/src/proto/shell.rs

@@ -2,7 +2,7 @@
 
 use uefi::boot::ScopedProtocol;
 use uefi::proto::shell::Shell;
-use uefi::{boot, cstr16};
+use uefi::{Error, Status, boot, cstr16};
 
 /// Test `current_dir()` and `set_current_dir()`
 pub fn test_current_dir(shell: &ScopedProtocol<Shell>) {
@@ -48,7 +48,11 @@ pub fn test_current_dir(shell: &ScopedProtocol<Shell>) {
 
     // At this point, the current working file system has not been set
     // So we expect a NULL output
-    assert!(shell.current_dir(None).is_none());
+    assert!(shell.current_dir(None).is_err());
+    assert_eq!(
+        shell.current_dir(None).err().unwrap(),
+        Error::new(Status::NOT_FOUND, ())
+    );
 
     // Setting the current working file system and current working directory
     let dir_var = cstr16!("fs0:/");

uefi/src/proto/shell/mod.rs

@@ -2,21 +2,19 @@
 
 //! EFI Shell Protocol v2.2
 
-use uefi_macros::unsafe_protocol;
-
+use crate::proto::unsafe_protocol;
+use crate::{CStr16, Char16, Error, Result, Status, StatusExt};
 use core::ptr;
-
 use uefi_raw::protocol::shell::ShellProtocol;
 
-use crate::{CStr16, Char16, Result, StatusExt};
-
 /// Shell Protocol
 #[derive(Debug)]
 #[repr(transparent)]
 #[unsafe_protocol(ShellProtocol::GUID)]
 pub struct Shell(ShellProtocol);
+
 impl Shell {
-    /// Returns the current directory on the specified device
+    /// Returns the current directory on the specified device.
     ///
     /// # Arguments
     ///
@@ -25,34 +23,32 @@ impl Shell {
     ///
     /// # Returns
     ///
-    /// * `Some(cwd)` - CStr16 containing the current working directory
-    /// * `None` - Could not retrieve current directory
-    #[must_use]
-    pub fn current_dir(&self, file_system_mapping: Option<&CStr16>) -> Option<&CStr16> {
+    /// * `Ok(cwd)` - CStr16 containing the current working directory
+    ///
+    /// # Errors
+    ///
+    /// * [`Status::NOT_FOUND`] - Could not retrieve current directory
+    pub fn current_dir(&self, file_system_mapping: Option<&CStr16>) -> Result<&CStr16> {
         let mapping_ptr: *const Char16 = file_system_mapping.map_or(ptr::null(), CStr16::as_ptr);
         let cur_dir = unsafe { (self.0.get_cur_dir)(mapping_ptr.cast()) };
         if cur_dir.is_null() {
-            None
+            Err(Error::new(Status::NOT_FOUND, ()))
         } else {
-            unsafe { Some(CStr16::from_ptr(cur_dir.cast())) }
+            unsafe { Ok(CStr16::from_ptr(cur_dir.cast())) }
         }
     }
 
     /// Changes the current directory on the specified device
     ///
     /// # Arguments
     ///
-    /// * `file_system` - Pointer to the file system's mapped name.
-    /// * `directory` - Points to the directory on the device specified by
+    /// * `file_system` - File system's mapped name.
+    /// * `directory` - Directory on the device specified by
     ///   `file_system`.
     ///
-    /// # Returns
-    ///
-    /// * `Status::SUCCESS` - The directory was successfully set
-    ///
     /// # Errors
     ///
-    /// * `Status::EFI_NOT_FOUND` - The directory does not exist
+    /// * [`Status::NOT_FOUND`] - The directory does not exist
     pub fn set_current_dir(
         &self,
         file_system: Option<&CStr16>,