Struct uefi::Status

#[repr(transparent)]
pub struct Status(pub usize);

UEFI uses status codes in order to report successes, errors, and warnings.

The spec allows implementation-specific status codes, so the Status constants are not a comprehensive list of all possible values.

Tuple Fields

0: usize

Implementations

impl Status

pub const SUCCESS: Status = _

The operation completed successfully.

pub const WARN_UNKNOWN_GLYPH: Status = _

The string contained characters that could not be rendered and were skipped.

pub const WARN_DELETE_FAILURE: Status = _

The handle was closed, but the file was not deleted.

pub const WARN_WRITE_FAILURE: Status = _

The handle was closed, but the data to the file was not flushed properly.

pub const WARN_BUFFER_TOO_SMALL: Status = _

The resulting buffer was too small, and the data was truncated.

pub const WARN_STALE_DATA: Status = _

The data has not been updated within the timeframe set by local policy.

pub const WARN_FILE_SYSTEM: Status = _

The resulting buffer contains UEFI-compliant file system.

pub const WARN_RESET_REQUIRED: Status = _

The operation will be processed across a system reset.

pub const LOAD_ERROR: Status = _

The image failed to load.

pub const INVALID_PARAMETER: Status = _

A parameter was incorrect.

pub const UNSUPPORTED: Status = _

The operation is not supported.

pub const BAD_BUFFER_SIZE: Status = _

The buffer was not the proper size for the request.

pub const BUFFER_TOO_SMALL: Status = _

The buffer is not large enough to hold the requested data. The required buffer size is returned in the appropriate parameter.

pub const NOT_READY: Status = _

There is no data pending upon return.

pub const DEVICE_ERROR: Status = _

The physical device reported an error while attempting the operation.

pub const WRITE_PROTECTED: Status = _

The device cannot be written to.

pub const OUT_OF_RESOURCES: Status = _

A resource has run out.

pub const VOLUME_CORRUPTED: Status = _

An inconstency was detected on the file system.

pub const VOLUME_FULL: Status = _

There is no more space on the file system.

pub const NO_MEDIA: Status = _

The device does not contain any medium to perform the operation.

pub const MEDIA_CHANGED: Status = _

The medium in the device has changed since the last access.

pub const NOT_FOUND: Status = _

The item was not found.

pub const ACCESS_DENIED: Status = _

Access was denied.

pub const NO_RESPONSE: Status = _

The server was not found or did not respond to the request.

pub const NO_MAPPING: Status = _

A mapping to a device does not exist.

pub const TIMEOUT: Status = _

The timeout time expired.

pub const NOT_STARTED: Status = _

The protocol has not been started.

pub const ALREADY_STARTED: Status = _

The protocol has already been started.

pub const ABORTED: Status = _

The operation was aborted.

pub const ICMP_ERROR: Status = _

An ICMP error occurred during the network operation.

pub const TFTP_ERROR: Status = _

A TFTP error occurred during the network operation.

pub const PROTOCOL_ERROR: Status = _

A protocol error occurred during the network operation.

pub const INCOMPATIBLE_VERSION: Status = _

The function encountered an internal version that was incompatible with a version requested by the caller.

pub const SECURITY_VIOLATION: Status = _

The function was not performed due to a security violation.

pub const CRC_ERROR: Status = _

A CRC error was detected.

pub const END_OF_MEDIA: Status = _

Beginning or end of media was reached

pub const END_OF_FILE: Status = _

The end of the file was reached.

pub const INVALID_LANGUAGE: Status = _

The language specified was invalid.

pub const COMPROMISED_DATA: Status = _

The security status of the data is unknown or compromised and the data must be updated or replaced to restore a valid security status.

pub const IP_ADDRESS_CONFLICT: Status = _

There is an address conflict address allocation

pub const HTTP_ERROR: Status = _

A HTTP error occurred during the network operation.

impl Status

pub const ERROR_BIT: usize = 9_223_372_036_854_775_808usize

Bit indicating that an UEFI status code is an error.

pub fn is_success(self) -> bool

Returns true if status code indicates success.

pub fn is_warning(self) -> bool

Returns true if status code indicates a warning.

pub const fn is_error(self) -> bool

Returns true if the status code indicates an error.

Trait Implementations

impl Clone for Status

fn clone(&self) -> Status

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Status

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

Formats the value using the given formatter.

impl Display for Status

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

Formats the value using the given formatter.

impl From<Status> for Error<()>

fn from(status: Status) -> Self

Converts to this type from the input type.

impl Hash for Status

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Status

fn cmp(&self, other: &Status) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Status

fn eq(&self, other: &Status) -> 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 PartialOrd for Status

fn partial_cmp(&self, other: &Status) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StatusExt for Status

fn to_result(self) -> Result

Converts this status code into a uefi::Result.

fn to_result_with_val<T>(self, val: impl FnOnce() -> T) -> Result<T, ()>

Converts this status code into a uefi::Result with a given Ok value.

fn to_result_with_err<ErrData: Debug>( self, err: impl FnOnce(Status) -> ErrData ) -> Result<(), ErrData>

Converts this status code into a uefi::Result with a given Err payload.

fn to_result_with<T, ErrData: Debug>( self, val: impl FnOnce() -> T, err: impl FnOnce(Status) -> ErrData ) -> Result<T, ErrData>

Convert this status code into a result with a given Ok value and Err payload.

impl Copy for Status

impl Eq for Status

impl StructuralPartialEq for Status