uefi: Move Status::into_with* methods to a new StatusExt trait

This is in preparation for moving `Status` to uefi-raw. since the `Error` type
and `Result` type alias will not move to uefi-raw, we can't move the `into_with`
methods to uefi-raw. And since we can't impl methods on a type defined in
another crate, we have to move these methods to a new trait.

Author: nicholasbishop

uefi/src/lib.rs

@@ -103,7 +103,7 @@ pub use self::data_types::{CStr16, CStr8, Char16, Char8, Event, Guid, Handle, Id
 pub use uefi_macros::{cstr16, cstr8, entry, guid};
 
 mod result;
-pub use self::result::{Error, Result, ResultExt, Status};
+pub use self::result::{Error, Result, ResultExt, Status, StatusExt};
 
 pub mod table;
 

uefi/src/mem.rs

@@ -108,7 +108,7 @@ pub(crate) fn make_boxed<
 #[cfg(test)]
 mod tests {
     use super::*;
-    use crate::ResultExt;
+    use crate::{ResultExt, StatusExt};
     #[cfg(feature = "unstable")]
     use alloc::alloc::Global;
     use core::mem::{align_of, size_of};

uefi/src/prelude.rs

@@ -2,7 +2,7 @@
 //!
 //! This includes the system table types, `Status` codes, etc.
 
-pub use crate::{Handle, ResultExt, Status};
+pub use crate::{Handle, ResultExt, Status, StatusExt};
 
 // Import the basic table types.
 pub use crate::table::boot::BootServices;

uefi/src/proto/console/gop.rs

@@ -52,7 +52,7 @@
 
 use crate::proto::unsafe_protocol;
 use crate::util::usize_from_u32;
-use crate::{Result, Status};
+use crate::{Result, Status, StatusExt};
 use core::fmt::{Debug, Formatter};
 use core::marker::PhantomData;
 use core::{mem, ptr};

uefi/src/proto/console/pointer/mod.rs

@@ -1,7 +1,7 @@
 //! Pointer device access.
 
 use crate::proto::unsafe_protocol;
-use crate::{Event, Result, Status};
+use crate::{Event, Result, Status, StatusExt};
 use core::mem::MaybeUninit;
 
 /// Provides information about a pointer device.

uefi/src/proto/console/serial.rs

@@ -3,7 +3,7 @@
 use core::fmt::Write;
 
 use crate::proto::unsafe_protocol;
-use crate::{Result, Status};
+use crate::{Result, Status, StatusExt};
 use bitflags::bitflags;
 
 /// Provides access to a serial I/O device.

uefi/src/proto/console/text/input.rs

@@ -1,5 +1,5 @@
 use crate::proto::unsafe_protocol;
-use crate::{Char16, Event, Result, Status};
+use crate::{Char16, Event, Result, Status, StatusExt};
 use core::mem::MaybeUninit;
 
 /// Interface for text-based input devices.

uefi/src/proto/console/text/output.rs

@@ -1,5 +1,5 @@
 use crate::proto::unsafe_protocol;
-use crate::{CStr16, Char16, Result, ResultExt, Status};
+use crate::{CStr16, Char16, Result, ResultExt, Status, StatusExt};
 use core::fmt;
 use core::fmt::{Debug, Formatter};
 

uefi/src/proto/debug/mod.rs

@@ -12,7 +12,7 @@
 use core::ffi::c_void;
 
 use crate::proto::unsafe_protocol;
-use crate::{Result, Status};
+use crate::{Result, Status, StatusExt};
 
 // re-export for ease of use
 pub use self::context::SystemContext;

uefi/src/proto/driver/component_name.rs

@@ -6,7 +6,7 @@
 
 use crate::proto::unsafe_protocol;
 use crate::table::boot::{BootServices, ScopedProtocol};
-use crate::{CStr16, Error, Handle, Result, Status};
+use crate::{CStr16, Error, Handle, Result, Status, StatusExt};
 use core::fmt::{Debug, Formatter};
 use core::{ptr, slice};
 

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

@@ -10,7 +10,7 @@ mod dir;
 mod info;
 mod regular;
 
-use crate::{CStr16, Char16, Guid, Result, Status};
+use crate::{CStr16, Char16, Guid, Result, Status, StatusExt};
 use bitflags::bitflags;
 use core::ffi::c_void;
 use core::fmt::Debug;

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

@@ -1,5 +1,5 @@
 use super::{File, FileHandle, FileInternal};
-use crate::{Result, Status};
+use crate::{Result, Status, StatusExt};
 
 /// A `FileHandle` that is also a regular (data) file.
 ///

uefi/src/proto/media/fs.rs

@@ -2,7 +2,7 @@
 
 use super::file::{Directory, FileHandle, FileImpl};
 use crate::proto::unsafe_protocol;
-use crate::{Result, Status};
+use crate::{Result, Status, StatusExt};
 use core::ptr;
 
 /// Allows access to a FAT-12/16/32 file system.

uefi/src/proto/network/pxe.rs

@@ -12,7 +12,7 @@ use crate::util::ptr_write_unaligned_and_add;
 use bitflags::bitflags;
 use ptr_meta::Pointee;
 
-use crate::{CStr8, Char8, Result, Status};
+use crate::{CStr8, Char8, Result, Status, StatusExt};
 
 use super::{IpAddress, MacAddress};
 

uefi/src/proto/network/snp.rs

@@ -9,7 +9,7 @@
 
 use super::{IpAddress, MacAddress};
 use crate::data_types::Event;
-use crate::{Result, Status};
+use crate::{Result, Status, StatusExt};
 use bitflags::bitflags;
 use core::ffi::c_void;
 use core::ptr;

uefi/src/proto/pi/mp.rs

@@ -12,7 +12,7 @@
 //! * maintaining MP-related processor status
 
 use crate::proto::unsafe_protocol;
-use crate::{Result, Status};
+use crate::{Result, Status, StatusExt};
 use bitflags::bitflags;
 use core::ffi::c_void;
 use core::ptr;

uefi/src/proto/rng.rs

@@ -2,7 +2,7 @@
 
 use crate::data_types::Guid;
 use crate::proto::unsafe_protocol;
-use crate::{guid, Result, Status};
+use crate::{guid, Result, Status, StatusExt};
 use core::{mem, ptr};
 
 newtype_enum! {

uefi/src/proto/security/memory_protection.rs

@@ -1,7 +1,7 @@
 use crate::data_types::PhysicalAddress;
 use crate::proto::unsafe_protocol;
 use crate::table::boot::MemoryAttribute;
-use crate::{Result, Status};
+use crate::{Result, Status, StatusExt};
 use core::ops::Range;
 
 /// Protocol for getting and setting memory protection attributes.

uefi/src/proto/tcg/v2.rs

@@ -14,7 +14,7 @@ use super::{v1, AlgorithmId, EventType, HashAlgorithm, PcrIndex};
 use crate::data_types::{PhysicalAddress, UnalignedSlice};
 use crate::proto::unsafe_protocol;
 use crate::util::{ptr_write_unaligned_and_add, usize_from_u32};
-use crate::{Error, Result, Status};
+use crate::{Error, Result, Status, StatusExt};
 use bitflags::bitflags;
 use core::fmt::{self, Debug, Formatter};
 use core::marker::PhantomData;

uefi/src/result/mod.rs

@@ -7,7 +7,7 @@ pub use self::error::Error;
 
 /// Definition of UEFI's standard status codes
 mod status;
-pub use self::status::Status;
+pub use self::status::{Status, StatusExt};
 
 /// Return type of most UEFI functions. Both success and error payloads are optional.
 ///

uefi/src/result/status.rs

@@ -127,26 +127,48 @@ impl Status {
     pub const fn is_error(self) -> bool {
         self.0 & ERROR_BIT != 0
     }
+}
 
+/// Extension trait which provides some convenience methods for [`Status`].
+pub trait StatusExt {
     /// Converts this status code into a [`uefi::Result`] with a given `Ok` value.
     ///
     /// If the status does not indicate success, the status representing the specific error
     /// code is embedded into the `Err` variant of type [`uefi::Error`].
+    fn into_with_val<T>(self, val: impl FnOnce() -> T) -> Result<T, ()>;
+
+    /// Converts this status code into a [`uefi::Result`] with a given `Err` payload.
+    ///
+    /// If the status does not indicate success, the status representing the specific error
+    /// code is embedded into the `Err` variant of type [`uefi::Error`].
+    fn into_with_err<ErrData: Debug>(
+        self,
+        err: impl FnOnce(Status) -> ErrData,
+    ) -> Result<(), ErrData>;
+
+    /// Convert this status code into a result with a given `Ok` value and `Err` payload.
+    ///
+    /// If the status does not indicate success, the status representing the specific error
+    /// code is embedded into the `Err` variant of type [`uefi::Error`].
+    fn into_with<T, ErrData: Debug>(
+        self,
+        val: impl FnOnce() -> T,
+        err: impl FnOnce(Status) -> ErrData,
+    ) -> Result<T, ErrData>;
+}
+
+impl StatusExt for Status {
     #[inline]
-    pub fn into_with_val<T>(self, val: impl FnOnce() -> T) -> Result<T, ()> {
+    fn into_with_val<T>(self, val: impl FnOnce() -> T) -> Result<T, ()> {
         if self.is_success() {
             Ok(val())
         } else {
             Err(self.into())
         }
     }
 
-    /// Converts this status code into a [`uefi::Result`] with a given `Err` payload.
-    ///
-    /// If the status does not indicate success, the status representing the specific error
-    /// code is embedded into the `Err` variant of type [`uefi::Error`].
     #[inline]
-    pub fn into_with_err<ErrData: Debug>(
+    fn into_with_err<ErrData: Debug>(
         self,
         err: impl FnOnce(Status) -> ErrData,
     ) -> Result<(), ErrData> {
@@ -157,12 +179,8 @@ impl Status {
         }
     }
 
-    /// Convert this status code into a result with a given `Ok` value and `Err` payload.
-    ///
-    /// If the status does not indicate success, the status representing the specific error
-    /// code is embedded into the `Err` variant of type [`uefi::Error`].
     #[inline]
-    pub fn into_with<T, ErrData: Debug>(
+    fn into_with<T, ErrData: Debug>(
         self,
         val: impl FnOnce() -> T,
         err: impl FnOnce(Status) -> ErrData,

uefi/src/table/boot.rs

@@ -4,7 +4,7 @@ use super::{Header, Revision};
 use crate::data_types::{Align, PhysicalAddress, VirtualAddress};
 use crate::proto::device_path::{DevicePath, FfiDevicePath};
 use crate::proto::{Protocol, ProtocolPointer};
-use crate::{Char16, Event, Guid, Handle, Result, Status};
+use crate::{Char16, Event, Guid, Handle, Result, Status, StatusExt};
 use bitflags::bitflags;
 use core::cell::UnsafeCell;
 use core::ffi::c_void;

uefi/src/table/runtime.rs

@@ -5,7 +5,7 @@ use super::{Header, Revision};
 use crate::data_types::FromSliceWithNulError;
 use crate::result::Error;
 use crate::table::boot::MemoryDescriptor;
-use crate::{guid, CStr16, Char16, Guid, Result, Status};
+use crate::{guid, CStr16, Char16, Guid, Result, Status, StatusExt};
 #[cfg(feature = "alloc")]
 use alloc::{vec, vec::Vec};
 use bitflags::bitflags;

uefi/src/table/system.rs

@@ -5,7 +5,7 @@ use core::ptr::NonNull;
 use core::{ptr, slice};
 
 use crate::proto::console::text;
-use crate::{CStr16, Char16, Handle, Result, Status};
+use crate::{CStr16, Char16, Handle, Result, Status, StatusExt};
 
 use super::boot::{BootServices, MemoryDescriptor, MemoryMap, MemoryType};
 use super::runtime::{ResetType, RuntimeServices};