Struct objc2::runtime::Bool

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

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::is_false or Bool::is_true methods as soon as possible.

This is FFI-safe and can be used in directly with msg_send!.

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

Example

use objc2::{class, msg_send};
use objc2::runtime::{Object, Bool};
let ns_value: *mut Object = unsafe { msg_send![class!(NSValue), initWithBool: Bool::YES] };
let rtn: Bool = unsafe { msg_send![ns_value, boolValue] };
assert!(rtn.is_true());

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 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.

pub const fn is_true(self) -> bool

Returns true if self is the opposite of NO.

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 Encode for Bool

const ENCODING: Encoding<'static>

The Objective-C type-encoding for this 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 RefEncode for Bool

const ENCODING_REF: Encoding<'static>

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

impl Copy for Bool