Struct uefi::data_types::Handle

pub struct Handle(/* private fields */);

Opaque handle to an UEFI entity (protocol, image…), guaranteed to be non-null.

If you need to have a nullable handle (for a custom UEFI FFI for example) use Option<Handle>.

Implementations

impl Handle

pub unsafe fn from_ptr(ptr: *mut c_void) -> Option<Self>

Creates a new Handle from a raw address. The address might come from the Multiboot2 information structure or something similar.

Example

use core::ffi::c_void;
use uefi::Handle;

let image_handle_addr = 0xdeadbeef as *mut c_void;

let uefi_image_handle = unsafe {
    Handle::from_ptr(image_handle_addr).expect("Pointer must not be null!")
};

Safety

This function is unsafe because the caller must be sure that the pointer is valid. Otherwise, further operations on the object might result in undefined behaviour, even if the methods aren’t marked as unsafe.

pub fn as_ptr(&self) -> *mut c_void

Get the underlying raw pointer.

Trait Implementations

impl Clone for Handle

fn clone(&self) -> Handle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Handle

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

Formats the value using the given formatter.

impl Hash for Handle

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

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 Handle

fn cmp(&self, other: &Handle) -> 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 Handle

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

fn partial_cmp(&self, other: &Handle) -> 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 Copy for Handle

impl Eq for Handle

impl StructuralPartialEq for Handle