Struct uefi::Error

pub struct Error<Data: Debug = ()> { /* private fields */ }

An UEFI-related error with optionally additional payload data. The error kind is encoded in the status field (see Status). Additional payload may be inside the data field.

Implementations

impl<Data: Debug> Error<Data>

pub const fn new(status: Status, data: Data) -> Self

Create an Error.

Panics

Panics if status is Status::SUCCESS.

pub const fn status(&self) -> Status

Get error Status.

pub const fn data(&self) -> &Data

Get error data.

pub fn split(self) -> (Status, Data)

Split this error into its inner status and error data

impl<Data: Debug> Error<Data>

pub fn to_err_without_payload(&self) -> Error<()>

Transforms the generic payload of an error to (). This is useful if you want

• to retain the erroneous status code,
• do not care about the payload, and
• refrain from generic type complexity in a higher API level.

Trait Implementations

impl<Data: Clone + Debug> Clone for Error<Data>

fn clone(&self) -> Error<Data>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<Data: Debug + Debug> Debug for Error<Data>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<Data: Debug> Display for Error<Data>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<Data: Debug> Error for Error<Data>

Available on crate feature unstable only.

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type based access to context intended for error reports.

impl From<Status> for Error<()>

fn from(status: Status) -> Self

Converts to this type from the input type.

impl<Data: PartialEq + Debug> PartialEq for Error<Data>

fn eq(&self, other: &Error<Data>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Data: Eq + Debug> Eq for Error<Data>

impl<Data: Debug> StructuralPartialEq for Error<Data>