Struct Boolean

#[repr(C)]
pub struct Boolean(/* private fields */);

Boolean Type

This boolean type works very similar to the rust primitive type of bool. However, the rust primitive type has no stable ABI, hence we provide this type to represent booleans on the FFI interface.

UEFI defines booleans to be 1-byte integers, which can only have the values of 0 or 1. However, in practice anything non-zero is considered true by nearly all UEFI systems. Hence, this type implements a boolean over u8 and maps 0 to false, everything else to true.

The binary representation of this type is ABI. That is, you are allowed to transmute from and to u8. Furthermore, this type never modifies its binary representation. If it was initialized as, or transmuted from, a specific integer value, this value will be retained. However, on the rust side you will never see the integer value. It instead behaves truly as a boolean. If you need access to the integer value, you have to transmute it back to u8.

Implementations

impl Boolean

pub const FALSE: Boolean

Literal False

This constant represents the false value of the Boolean type.

pub const TRUE: Boolean

Literal True

This constant represents the true value of the Boolean type.

Trait Implementations

impl Clone for Boolean

fn clone(&self) -> Boolean

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Boolean

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

Formats the value using the given formatter.

impl Default for Boolean

fn default() -> Self

Returns the “default value” for a type.

impl From<Boolean> for bool

fn from(v: Boolean) -> Self

Converts to this type from the input type.

impl From<Boolean> for u8

fn from(v: Boolean) -> Self

Converts to this type from the input type.

impl From<bool> for Boolean

fn from(v: bool) -> Self

Converts to this type from the input type.

impl From<u8> for Boolean

fn from(v: u8) -> Self

Converts to this type from the input type.

impl Hash for Boolean

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 Boolean

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

Restrict a value to a certain interval.

impl PartialEq<bool> for Boolean

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq for Boolean

fn eq(&self, other: &Boolean) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd<bool> for Boolean

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl PartialOrd for Boolean

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for Boolean

impl Eq for Boolean