Skip to content

Commit d647d46

Browse files
committed
improve uefi::Error documentation
1 parent 26717f6 commit d647d46

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

uefi/src/result/error.rs

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
1+
//! Module for UEFI-specific error encodings. See [`Error`].
2+
13
use super::Status;
24
use core::fmt::{Debug, Display};
35

4-
/// Errors emitted from UEFI entry point must propagate erroneous UEFI statuses,
5-
/// and may optionally propagate additional entry point-specific data.
6+
/// An UEFI-related error with optionally additional payload data. The error
7+
/// kind is encoded in the `status` field (see [`Status`]). Additional payload
8+
/// may be inside the `data` field.
69
#[derive(Debug, PartialEq, Eq)]
710
pub struct Error<Data: Debug = ()> {
811
status: Status,

0 commit comments

Comments
 (0)