Struct uefi::table::boot::ScopedProtocol

pub struct ScopedProtocol<'a, P: Protocol + ?Sized> { /* private fields */ }

An open protocol interface. Automatically closes the protocol interface on drop.

Most protocols have interface data associated with them. ScopedProtocol implements Deref and DerefMut to access this data. A few protocols (such as DevicePath and LoadedImageDevicePath) may be installed with null interface data, in which case Deref and DerefMut will panic. The get and get_mut methods may be used to access the optional interface data without panicking.

See also the BootServices documentation for details of how to open a protocol and why UnsafeCell is used.

Implementations

impl<'a, P: Protocol + ?Sized> ScopedProtocol<'a, P>

pub fn get(&self) -> Option<&P>

Get the protocol interface data, or None if the open protocol’s interface is null.

pub fn get_mut(&self) -> Option<&mut P>

Get the protocol interface data, or None if the open protocol’s interface is null.

Trait Implementations

impl<'a, P: Debug + Protocol + ?Sized> Debug for ScopedProtocol<'a, P>

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

Formats the value using the given formatter.

impl<'a, P: Protocol + ?Sized> Deref for ScopedProtocol<'a, P>

type Target = P

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a, P: Protocol + ?Sized> DerefMut for ScopedProtocol<'a, P>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'a, P: Protocol + ?Sized> Drop for ScopedProtocol<'a, P>

fn drop(&mut self)

Executes the destructor for this type.