Struct objc2::runtime::Bool

#[repr(transparent)]
pub struct Bool { /* private fields */ }

The Objective-C BOOL type.

This is a thin wrapper-type over objc_sys::BOOL. 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.

Note that this is able to contain more states than bool on some platforms, but these cases should not be relied on!

Implementations

impl Bool

pub const YES: Bool = Self::from_raw(objc_sys::YES)

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

pub const NO: Bool = Self::from_raw(objc_sys::NO)

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

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

Creates an Objective-C boolean from a Rust boolean.

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

Creates this from a boolean value received from a raw Objective-C API.

pub const fn as_raw(self) -> bool

Retrieves the inner objc_sys::BOOL boolean type, to be used in raw Objective-C APIs.

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 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<(), Error>

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 = objc_sys::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 RefEncode for Bool

const ENCODING_REF: Encoding = Encoding::Pointer(&Self::ENCODING)

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

impl Copy for Bool