Struct Bool32 

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

A 32-bit bool-ish type.

This is repr(transparent) and wraps a u32. When the value is 0 it’s “false” and when the value is non-zero it’s “true”. The methods of this type only ever allow the wrapped value to be 0 or 1, but if you make this type interact with foreign functions they could produce other non-zero values. It is not an absolute invariant of this type that the wrapped value always be exactly 0 or 1, the wrapped value can be any value.

For readability, the type formats with Debug and Display just like a bool, showing as either true or false.

Implementations

impl Bool32

pub const FALSE: Self

Constant for the false value.

pub const TRUE: Self

Constant for the canonical true value.

Note that any non-zero wrapped value is considered to be “true”, this is just the canonical true value (1).

pub const fn new(b: bool) -> Self

Like Bool32::from(bool), but const fn.

const F: Bool32 = Bool32::new(false);
const T: Bool32 = Bool32::new(true);
assert_eq!(F, Bool32::FALSE);
assert_eq!(T, Bool32::TRUE);

Trait Implementations

impl Clone for Bool32

fn clone(&self) -> Bool32

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Bool32

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

assert_eq!(format!("{:?}", true), format!("{:?}", Bool32::TRUE));
assert_eq!(format!("{:?}", false), format!("{:?}", Bool32::FALSE));

impl Default for Bool32

fn default() -> Bool32

Returns the “default value” for a type.

impl Display for Bool32

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

assert_eq!(format!("{}", true), format!("{}", Bool32::TRUE));
assert_eq!(format!("{}", false), format!("{}", Bool32::FALSE));

impl From<Bool32> for bool

fn from(value: Bool32) -> Self

assert_eq!(Bool32::from(true), Bool32::TRUE);
assert_eq!(Bool32::from(false), Bool32::FALSE);

impl From<bool> for Bool32

fn from(value: bool) -> Self

assert!(bool::from(Bool32::new(true)));
assert!(!bool::from(Bool32::new(false)));

impl Hash for Bool32

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 Bool32

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

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

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

impl Eq for Bool32

impl StructuralPartialEq for Bool32