Struct objc2::runtime::NSObject

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

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§

source§

impl NSObject

source

pub fn new() -> Retained<Self>

Create a new empty NSObject.

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

source

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());
source

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

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

source

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());
source

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.

source

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§

source§

impl AsMut<AnyObject> for NSObject

source§

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

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

impl AsMut<NSObject> for NSObject

source§

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

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

impl AsRef<AnyObject> for NSObject

source§

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for NSObject

source§

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for NSObject

source§

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value. Read more
source§

impl BorrowMut<AnyObject> for NSObject

source§

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

Mutably borrows from an owned value. Read more
source§

impl ClassType for NSObject

§

type Super = AnyObject

The superclass of this class. Read more
§

type Mutability = Root

Whether the type is mutable or immutable. Read more
source§

const NAME: &'static str = "NSObject"

The name of the Objective-C class that this type represents. Read more
source§

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents. Read more
source§

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

Get an immutable reference to the superclass.
source§

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

Get a mutable reference to the superclass.
source§

fn alloc() -> Allocated<Self>

Allocate a new instance of the class. Read more
source§

impl Debug for NSObject

source§

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

Formats the value using the given formatter. Read more
source§

impl DefaultRetained for NSObject

source§

fn default_id() -> Retained<Self>

The default Retained for a type. Read more
source§

fn default_retained() -> Retained<Self>

The default Retained for a type. Read more
source§

impl Deref for NSObject

§

type Target = AnyObject

The resulting type after dereferencing.
source§

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

Dereferences the value.
source§

impl DerefMut for NSObject

source§

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

Mutably dereferences the value.
source§

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

source§

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl NSObjectProtocol for NSObject

source§

fn isEqual(&self, other: &AnyObject) -> bool
where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object. Read more
source§

fn hash(&self) -> NSUInteger
where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure. Read more
source§

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. Read more
source§

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. Read more
source§

fn isMemberOfClass(&self, cls: &AnyClass) -> bool
where Self: Sized + Message,

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

fn respondsToSelector(&self, aSelector: Sel) -> bool
where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector. Read more
source§

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool
where Self: Sized + Message,

Check whether the object conforms to a given protocol. Read more
source§

fn description(&self) -> Retained<NSObject>
where Self: Sized + Message,

A textual representation of the object. Read more
source§

fn debugDescription(&self) -> Retained<NSObject>
where Self: Sized + Message,

A textual representation of the object to use when debugging. Read more
source§

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. Read more
source§

fn retainCount(&self) -> NSUInteger
where Self: Sized + Message,

The reference count of the object. Read more
source§

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/

source§

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

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

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

impl RefEncode for NSObject

source§

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

The Objective-C type-encoding for a reference of this type. Read more
source§

impl Eq for NSObject

Most types’ equality is reflexive.

source§

impl Message for NSObject

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> CounterpartOrSelf for T
where T: ClassType + ?Sized, <T as ClassType>::Mutability: MutabilityCounterpartOrSelf<T>,

§

type Immutable = <<T as ClassType>::Mutability as MutabilityCounterpartOrSelf<T>>::Immutable

The immutable counterpart of the type, or Self if the type has no immutable counterpart. Read more
§

type Mutable = <<T as ClassType>::Mutability as MutabilityCounterpartOrSelf<T>>::Mutable

The mutable counterpart of the type, or Self if the type has no mutable counterpart. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> AutoreleaseSafe for T
where T: ?Sized,

source§

impl<T> IsAllocableAnyThread for T
where T: ClassType + ?Sized, <T as ClassType>::Mutability: MutabilityIsAllocableAnyThread,

source§

impl<T> IsAllowedMutable for T
where T: ClassType + ?Sized, <T as ClassType>::Mutability: MutabilityIsAllowedMutable,

source§

impl<T> IsIdCloneable for T
where T: ClassType + ?Sized, <T as ClassType>::Mutability: MutabilityIsIdCloneable,