Struct Bool 

pub struct Bool { /* private fields */ }

The Objective-C BOOL type.

The type of BOOL varies across platforms, so we expose this wrapper. It is intended that you convert this into a Rust bool with the Bool::as_bool method as soon as possible.

This is FFI-safe and can be used directly with msg_send! and extern functions as a substitute for BOOL in Objective-C. If your Objective-C code uses C99 _Bool, you should use a #[repr(transparent)] wrapper around bool instead.

Note that this is able to contain more states than bool on some platforms, but these cases should not be relied on! The comparison traits PartialEq, PartialOrd etc. will completely ignore these states.

See also the corresponding documentation entry.

Implementations

impl Bool

pub const YES: Self

The equivalent of true for Objective-C’s BOOL type.

pub const NO: Self

The equivalent of false for Objective-C’s BOOL type.

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

Creates an Objective-C boolean from a Rust boolean.

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

Creates this from a raw boolean value.

Avoid this, and instead use Bool in the raw FFI signature.

pub const fn as_raw(self) -> bool

Retrieves the inner boolean type.

Avoid this, and instead use Bool in the raw FFI signature.

pub const fn is_false(self) -> bool

Returns true if self is NO.

You should prefer using as_bool.

pub const fn is_true(self) -> bool

Returns true if self is not NO.

You should prefer using as_bool.

pub const fn as_bool(self) -> bool

Converts this into the bool equivalent.

Trait Implementations

impl Clone for Bool

fn clone(&self) -> Bool

Returns a duplicate 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 Encode for Bool

const ENCODING: Encoding = inner::BOOL::__ENCODING

The Objective-C type-encoding for this type.

impl From<Bool> for bool

fn from(b: Bool) -> bool

Converts to this type from the input type.

impl From<bool> for Bool

fn from(b: bool) -> Bool

Converts to this type from the input type.

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Bool

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

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

fn partial_cmp(&self, other: &Self) -> 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 RefEncode for Bool

const ENCODING_REF: Encoding

The Objective-C type-encoding for a reference of this type.

impl Copy for Bool

impl Eq for Bool