Struct objc2::runtime::NSObject

#[repr(C)]
pub struct NSObject { /* private fields */ }

The root class of most Objective-C class hierarchies.

This represents the NSObject class. The name “NSObject” also refers to a protocol, see NSObjectProtocol for that.

Since this class is only available with the Foundation framework, objc2 links to it for you.

This is exported under objc2_foundation::NSObject, you probably want to use that path instead.

Implementations

impl NSObject

pub fn new() -> Retained<Self>

Create a new empty NSObject.

This method is a shorthand for calling alloc and then init.

pub fn init(this: Allocated<Self>) -> Retained<Self>

Initialize an already allocated object.

See Apple’s documentation for details.

Example

use objc2::runtime::NSObject;
use objc2::ClassType;

let obj = NSObject::init(NSObject::alloc());

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

pub unsafe fn get_ivar<T: Encode>(&self, name: &str) -> &T

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Use Ivar::load instead.

Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

pub unsafe fn get_mut_ivar<T: Encode>(&mut self, name: &str) -> &mut T

👎Deprecated: this is difficult to use correctly, use Ivar::load_mut instead.

Use Ivar::load_mut instead.

Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

Trait Implementations

impl AsMut<AnyObject> for NSObject

fn as_mut(&mut self) -> &mut AnyObject

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<NSObject> for NSObject

fn as_mut(&mut self) -> &mut Self

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<AnyObject> for NSObject

fn as_ref(&self) -> &AnyObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSObject> for NSObject

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<AnyObject> for NSObject

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl BorrowMut<AnyObject> for NSObject

fn borrow_mut(&mut self) -> &mut AnyObject

Mutably borrows from an owned value.

impl ClassType for NSObject

type Super = AnyObject

The superclass of this class.

type Mutability = Root

Whether the type is mutable or immutable.

const NAME: &'static str = "NSObject"

The name of the Objective-C class that this type represents.

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

fn as_super_mut(&mut self) -> &mut Self::Super

Get a mutable reference to the superclass.

fn alloc() -> Allocated<Self>

where Self: IsAllocableAnyThread + Sized,

Allocate a new instance of the class.

impl Debug for NSObject

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

Formats the value using the given formatter.

impl DefaultRetained for NSObject

fn default_id() -> Retained<Self>

The default Retained for a type.

fn default_retained() -> Retained<Self>

The default Retained for a type.

impl Deref for NSObject

type Target = AnyObject

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for NSObject

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Hash for NSObject

Hashing in Objective-C has the exact same requirement as in Rust:

If two objects are equal (as determined by the isEqual: method), they must have the same hash value.

See https://developer.apple.com/documentation/objectivec/1418956-nsobject/1418859-hash

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 NSObjectProtocol for NSObject

fn isEqual(&self, other: &AnyObject) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> NSUInteger

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T: ClassType>(&self) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> NSUInteger

where Self: Sized + Message,

The reference count of the object.

impl PartialEq for NSObject

Objective-C equality has approximately the same semantics as Rust equality (although less aptly specified).

At the very least, equality is expected to be symmetric and transitive, and that’s about the best we can do.

See also https://nshipster.com/equality/

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for NSObject

const ENCODING_REF: Encoding = <AnyObject as crate::RefEncode>::ENCODING_REF

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

impl Eq for NSObject

Most types’ equality is reflexive.

impl Message for NSObject