uefi: Modifying functions to return Result instead of Status

Author: RenTrieu

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

@@ -3,7 +3,6 @@
 use uefi::boot::ScopedProtocol;
 use uefi::proto::shell::Shell;
 use uefi::{boot, cstr16};
-use uefi_raw::Status;
 
 /// Test `var()`, `vars()`, and `set_var()`
 pub fn test_env(shell: &ScopedProtocol<Shell>) {
@@ -21,7 +20,7 @@ pub fn test_env(shell: &ScopedProtocol<Shell>) {
     let test_val = cstr16!("test_val");
     assert!(shell.var(test_var).is_none());
     let status = shell.set_var(test_var, test_val, false);
-    assert_eq!(status, Status::SUCCESS);
+    assert!(status.is_ok());
     let cur_env_str = shell
         .var(test_var)
         .expect("Could not get environment variable");
@@ -49,7 +48,7 @@ pub fn test_env(shell: &ScopedProtocol<Shell>) {
     /* Test deleting environment variable */
     let test_val = cstr16!("");
     let status = shell.set_var(test_var, test_val, false);
-    assert_eq!(status, Status::SUCCESS);
+    assert!(status.is_ok());
     assert!(shell.var(test_var).is_none());
 
     let cur_env_vec = shell.vars();
@@ -70,7 +69,7 @@ pub fn test_cur_dir(shell: &ScopedProtocol<Shell>) {
     let fs_var = cstr16!("fs0:");
     let dir_var = cstr16!("/");
     let status = shell.set_current_dir(Some(fs_var), Some(dir_var));
-    assert_eq!(status, Status::SUCCESS);
+    assert!(status.is_ok());
 
     let cur_fs_str = shell
         .current_dir(Some(fs_var))
@@ -82,7 +81,7 @@ pub fn test_cur_dir(shell: &ScopedProtocol<Shell>) {
     let fs_var = cstr16!("fs1:");
     let dir_var = cstr16!("/");
     let status = shell.set_current_dir(Some(fs_var), Some(dir_var));
-    assert_eq!(status, Status::SUCCESS);
+    assert!(status.is_ok());
 
     let cur_fs_str = shell
         .current_dir(Some(fs_var))
@@ -95,7 +94,7 @@ pub fn test_cur_dir(shell: &ScopedProtocol<Shell>) {
     let fs_var = cstr16!("fs0:");
     let dir_var = cstr16!("efi/");
     let status = shell.set_current_dir(Some(fs_var), Some(dir_var));
-    assert_eq!(status, Status::SUCCESS);
+    assert!(status.is_ok());
 
     let cur_fs_str = shell
         .current_dir(Some(fs_var))
@@ -113,7 +112,7 @@ pub fn test_cur_dir(shell: &ScopedProtocol<Shell>) {
     // Setting the current working file system and current working directory
     let dir_var = cstr16!("fs0:/");
     let status = shell.set_current_dir(None, Some(dir_var));
-    assert_eq!(status, Status::SUCCESS);
+    assert!(status.is_ok());
     let cur_fs_str = shell
         .current_dir(Some(fs_var))
         .expect("Could not get the current file system mapping");
@@ -128,7 +127,7 @@ pub fn test_cur_dir(shell: &ScopedProtocol<Shell>) {
     // Changing current working directory
     let dir_var = cstr16!("/efi");
     let status = shell.set_current_dir(None, Some(dir_var));
-    assert_eq!(status, Status::SUCCESS);
+    assert!(status.is_ok());
     let cur_fs_str = shell
         .current_dir(Some(fs_var))
         .expect("Could not get the current file system mapping");
@@ -143,7 +142,7 @@ pub fn test_cur_dir(shell: &ScopedProtocol<Shell>) {
     let fs_var = cstr16!("fs0:");
     let dir_var = cstr16!("efi/tools");
     let status = shell.set_current_dir(Some(fs_var), Some(dir_var));
-    assert_eq!(status, Status::SUCCESS);
+    assert!(status.is_ok());
     let cur_fs_str = shell
         .current_dir(None)
         .expect("Could not get the current file system mapping");

uefi/src/proto/shell/mod.rs

@@ -3,14 +3,13 @@
 //! EFI Shell Protocol v2.2
 
 use uefi_macros::unsafe_protocol;
-use uefi_raw::Status;
 
 use core::marker::PhantomData;
 use core::ptr;
 
 use uefi_raw::protocol::shell::ShellProtocol;
 
-use crate::{CStr16, Char16};
+use crate::{CStr16, Char16, Result, StatusExt};
 
 /// Shell Protocol
 #[derive(Debug)]
@@ -68,7 +67,7 @@ impl Shell {
 
     /// Gets an iterator over the names of all environment variables
     #[must_use]
-    pub fn vars(&self) -> Vars {
+    pub fn vars(&self) -> Vars<'_> {
         let env_ptr = unsafe { (self.0.get_env)(ptr::null()) };
         Vars {
             inner: env_ptr.cast::<Char16>(),
@@ -88,10 +87,10 @@ impl Shell {
     /// # Returns
     ///
     /// * `Status::SUCCESS` - The variable was successfully set
-    pub fn set_var(&self, name: &CStr16, value: &CStr16, volatile: bool) -> Status {
+    pub fn set_var(&self, name: &CStr16, value: &CStr16, volatile: bool) -> Result {
         let name_ptr: *const Char16 = name.as_ptr();
         let value_ptr: *const Char16 = value.as_ptr();
-        unsafe { (self.0.set_env)(name_ptr.cast(), value_ptr.cast(), volatile) }
+        unsafe { (self.0.set_env)(name_ptr.cast(), value_ptr.cast(), volatile) }.to_result()
     }
 
     /// Returns the current directory on the specified device
@@ -131,10 +130,14 @@ impl Shell {
     /// # Errors
     ///
     /// * `Status::EFI_NOT_FOUND` - The directory does not exist
-    pub fn set_current_dir(&self, file_system: Option<&CStr16>, directory: Option<&CStr16>) -> Status {
+    pub fn set_current_dir(
+        &self,
+        file_system: Option<&CStr16>,
+        directory: Option<&CStr16>,
+    ) -> Result {
         let fs_ptr: *const Char16 = file_system.map_or(ptr::null(), |x| (x.as_ptr()));
         let dir_ptr: *const Char16 = directory.map_or(ptr::null(), |x| (x.as_ptr()));
-        unsafe { (self.0.set_cur_dir)(fs_ptr.cast(), dir_ptr.cast()) }
+        unsafe { (self.0.set_cur_dir)(fs_ptr.cast(), dir_ptr.cast()) }.to_result()
     }
 }