Skip to content

Commit cae8718

Browse files
phip1611nicholasbishop
authored andcommitted
loaded_image: doc improvements
1 parent 75430f0 commit cae8718

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

uefi/src/proto/loaded_image.rs

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,10 +56,15 @@ impl LoadedImage {
5656
self.device_handle
5757
}
5858

59-
/// Get a reference to the `file_path`.
59+
/// Get a reference to the `file_path` portion of the DeviceHandle that the
60+
/// EFI image was loaded from.
6061
///
61-
/// Return `None` if the pointer to the file path portion specific to
62-
/// DeviceHandle that the EFI Image was loaded from is null.
62+
/// For a full device path, consider using the [`LoadedImageDevicePath`]
63+
/// protocol.
64+
///
65+
/// Returns `None` if `file_path` is null.
66+
///
67+
/// [`LoadedImageDevicePath`]: crate::proto::device_path::LoadedImageDevicePath
6368
#[must_use]
6469
pub fn file_path(&self) -> Option<&DevicePath> {
6570
if self.file_path.is_null() {

0 commit comments

Comments
 (0)