uefi: rename DevicePath[Node]::{to_string -> to_string16}()

This is a pre-requisite for the next commit that implements
Display. Display comes with a to_string() method already.

Author: phip1611

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

@@ -107,7 +107,7 @@ fn test_device_path_to_string() {
     let path = create_test_device_path();
 
     let to_text =
-        |display_only, allow_shortcuts| path.to_string(display_only, allow_shortcuts).unwrap();
+        |display_only, allow_shortcuts| path.to_string16(display_only, allow_shortcuts).unwrap();
 
     assert_eq!(
         &*to_text(DisplayOnly(true), AllowShortcuts(true)),
@@ -167,7 +167,7 @@ fn test_device_path_node_to_string() {
     let nodes: Vec<_> = path.node_iter().collect();
 
     let to_text = |node: &DevicePathNode, display_only, allow_shortcuts| {
-        node.to_string(display_only, allow_shortcuts).unwrap()
+        node.to_string16(display_only, allow_shortcuts).unwrap()
     };
 
     assert_eq!(
@@ -229,20 +229,20 @@ fn test_device_path_append() {
     let node = path.node_iter().next().unwrap();
 
     assert_eq!(
-        path.to_string(DisplayOnly(false), AllowShortcuts(false))
+        path.to_string16(DisplayOnly(false), AllowShortcuts(false))
             .unwrap(),
         cstr16!("Ata(Primary,Master,0x1)/VenMsg(E0C14753-F9BE-11D2-9A0C-0090273FC14D)")
     );
     assert_eq!(
-        node.to_string(DisplayOnly(false), AllowShortcuts(false))
+        node.to_string16(DisplayOnly(false), AllowShortcuts(false))
             .unwrap(),
         cstr16!("Ata(Primary,Master,0x1)")
     );
 
     assert_eq!(
         path.append_path(&path2)
             .unwrap()
-            .to_string(DisplayOnly(false), AllowShortcuts(false))
+            .to_string16(DisplayOnly(false), AllowShortcuts(false))
             .unwrap(),
         cstr16!(
             "Ata(Primary,Master,0x1)/VenMsg(E0C14753-F9BE-11D2-9A0C-0090273FC14D)/Ata(Primary,Master,0x1)/VenMsg(E0C14753-F9BE-11D2-9A0C-0090273FC14D)"
@@ -251,7 +251,7 @@ fn test_device_path_append() {
     assert_eq!(
         path.append_node(node)
             .unwrap()
-            .to_string(DisplayOnly(false), AllowShortcuts(false))
+            .to_string16(DisplayOnly(false), AllowShortcuts(false))
             .unwrap(),
         cstr16!(
             "Ata(Primary,Master,0x1)/VenMsg(E0C14753-F9BE-11D2-9A0C-0090273FC14D)/Ata(Primary,Master,0x1)"

uefi-test-runner/src/proto/network/http.rs

@@ -15,7 +15,7 @@ pub fn print_handle_devpath(prefix: &str, handle: &Handle) {
         info!("{prefix}no device path for handle");
         return;
     };
-    if let Ok(string) = dp.to_string(DisplayOnly(true), AllowShortcuts(true)) {
+    if let Ok(string) = dp.to_string16(DisplayOnly(true), AllowShortcuts(true)) {
         info!("{prefix}{string}");
     }
 }

uefi-test-runner/src/proto/nvme/pass_thru.rs

@@ -27,7 +27,7 @@ fn has_nvme_drive() -> bool {
         };
         let nvme_pt = boot::open_protocol_exclusive::<NvmePassThru>(nvme_pt_handle).unwrap();
         let device_path_str = device_path
-            .to_string(DisplayOnly(true), AllowShortcuts(false))
+            .to_string16(DisplayOnly(true), AllowShortcuts(false))
             .unwrap();
         info!("- Successfully opened NVMe: {device_path_str}");
         let mut nvme_ctrl = nvme_pt.controller();

uefi-test-runner/src/proto/pci/root_bridge.rs

@@ -45,7 +45,7 @@ pub fn test() {
             let subclass_code = ((reg1 >> 16) & 0xFF) as u8;
             let device_path = pci_tree.device_path(&root_device_path, addr).unwrap();
             let device_path_str = device_path
-                .to_string(DisplayOnly(false), AllowShortcuts(false))
+                .to_string16(DisplayOnly(false), AllowShortcuts(false))
                 .unwrap()
                 .to_string();
 
@@ -81,7 +81,7 @@ pub fn test() {
     for scsi_handle in scsi_handles {
         let device_path = get_open_protocol::<DevicePath>(scsi_handle);
         let device_path = device_path
-            .to_string(DisplayOnly(false), AllowShortcuts(false))
+            .to_string16(DisplayOnly(false), AllowShortcuts(false))
             .unwrap()
             .to_string();
         assert!(mass_storage_dev_paths.contains(&device_path));

uefi/CHANGELOG.md

@@ -28,6 +28,12 @@
 - **Breaking:** `boot::check_event` now consumes `&Event` rather than `Event`, removing the
   need for unnecessary `Event::unsafe_clone()`s.
 - MSRV increased to 1.88.
+- **Breaking:** Renamed `DevicePath::to_string()` to `DevicePath::to_string16()`
+  to better differentiate with the new `to_string()` coming from the new
+  `Display`.
+- **Breaking:** Renamed `DevicePathNode::to_string()` to `DevicePathNode::to_string16()`
+  to better differentiate with the new `to_string()` coming from the new
+  `Display`.
 
 # uefi - v0.36.1 (2025-11-05)
 

uefi/src/proto/device_path/mod.rs

@@ -301,10 +301,10 @@ impl DevicePathNode {
         DevicePathNodeEnum::try_from(self)
     }
 
-    /// Transforms the device path node to its string representation using the
-    /// [`DevicePathToText`] protocol.
+    /// Transforms the device path node to an owned UEFI string ([`CString16`])
+    /// using the [`DevicePathToText`] protocol.
     #[cfg(feature = "alloc")]
-    pub fn to_string(
+    pub fn to_string16(
         &self,
         display_only: DisplayOnly,
         allow_shortcuts: AllowShortcuts,
@@ -460,7 +460,7 @@ impl ToOwned for DevicePathInstance {
 ///         = open_protocol_exclusive::<DevicePath>(device_handle).unwrap();
 ///     log::debug!(
 ///         "Device path: {}",
-///         device_path.to_string(DisplayOnly(true), AllowShortcuts(true)).unwrap()
+///         device_path.to_string16(DisplayOnly(true), AllowShortcuts(true)).unwrap()
 ///     );
 /// }
 /// ```
@@ -598,10 +598,11 @@ impl DevicePath {
             .map_err(|_| DevicePathUtilitiesError::OutOfMemory)
     }
 
-    /// Transforms the device path to its string representation using the
-    /// [`DevicePathToText`] protocol.
+    /// Transforms the device path to an owned UEFI string ([`CString16`])
+    /// using the [`DevicePathToText`] protocol.
     #[cfg(feature = "alloc")]
-    pub fn to_string(
+    // to_string() comes from Display and produces a Rust string.
+    pub fn to_string16(
         &self,
         display_only: DisplayOnly,
         allow_shortcuts: AllowShortcuts,
@@ -831,9 +832,9 @@ impl Deref for LoadedImageDevicePath {
 }
 
 /// Errors that may happen when a device path is transformed to a string
-/// representation using:
-/// - [`DevicePath::to_string`]
-/// - [`DevicePathNode::to_string`]
+/// using:
+/// - [`DevicePath::to_string16`]
+/// - [`DevicePathNode::to_string16`]
 #[derive(Debug)]
 pub enum DevicePathToTextError {
     /// Can't locate a handle buffer with handles associated with the