Struct fruity__bbqsrc::objc::BOOL

#[repr(transparent)]
pub struct BOOL { /* fields omitted */ }

The boolean value type.

See documentation.

Memory Representation

On Intel OS X and 32-bit iOS, Objective-C’s BOOL type is a signed char. Everywhere else it is C/C++’s Bool.

As a result, this type is a #[repr(transparent)] wrapper around c_schar (a.k.a. i8) or bool respectively.

This crate uses a newtype instead of a type alias because aliasing bool would allow for if x on some platforms but not others. When using this type in a conditional statement, use is_yes.

Implementations

impl BOOL

pub const NO: Self

The BOOL equivalent to false.

See documentation.

pub const YES: Self

The BOOL equivalent to true.

See documentation.

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

Creates an Objective-C boolean from a Rust boolean.

pub const fn is_no(self) -> bool

Returns true if self should be treated like NO.

pub const fn is_yes(self) -> bool

Returns true if self should be treated like YES.

Trait Implementations

impl Clone for BOOL

fn clone(&self) -> BOOL

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BOOL

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

Formats the value using the given formatter.

impl Default for BOOL

fn default() -> BOOL

Returns the “default value” for a type.

impl From<BOOL> for bool

fn from(b: BOOL) -> bool

Performs the conversion.

impl From<bool> for BOOL

fn from(b: bool) -> BOOL

Performs the conversion.

impl Hash for BOOL

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, 

Feeds a slice of this type into the given Hasher.

impl Ord for BOOL

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<BOOL> for BOOL

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<BOOL> for BOOL

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

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 BOOL

impl Eq for BOOL

impl StructuralEq for BOOL

impl StructuralPartialEq for BOOL