#[repr(C)]pub struct AnyObject(_);Expand description
An Objective-C object.
This is slightly different from NSObject in that it may represent an
instance of an arbitary Objective-C class (e.g. it does not have to be
a subclass of NSObject, so it can represent other root classes like
NSProxy).
Id<AnyObject> is equivalent to Objective-C’s id _Nonnull.
This contains UnsafeCell, and is similar to that in that one can
safely access and perform interior mutability on this (both via.
msg_send! and through ivars), so long as Rust’s mutability rules are
upheld, and that data races are avoided.
Note: This is intentionally neither Sync, Send, UnwindSafe,
RefUnwindSafe nor Unpin, since that is something that may change
depending on the specific subclass. For example, NSAutoreleasePool is
not Send, it has to be deallocated on the same thread that it was
created. NSLock is not Send either.
This is somewhat similar to ffi::objc_object.
Implementations§
source§impl AnyObject
impl AnyObject
sourcepub unsafe fn set_class<'s>(this: &Self, cls: &AnyClass) -> &'s AnyClass
pub unsafe fn set_class<'s>(this: &Self, cls: &AnyClass) -> &'s AnyClass
Change the class of the object at runtime.
Returns the object’s previous class.
Safety
The new class must:
-
Be a subclass of the object’s current class.
-
The subclass must not add any instance variables - importantly, the instance size of old and the new classes must be the same.
-
Any overridden methods on the new class must be fully compatible with the old ones.
Note that in the general case, where arbitary parts of the program may be trying to modify the class of the object concurrently, these requirements are not actually possible to uphold.
Since usage of this function is expected to be extremely rare, and even more so trying to do it concurrently, it is recommended that you verify that the returned class is what you would expect, and if not, panic.
sourcepub unsafe fn ivar_ptr<T: Encode>(&self, name: &str) -> *mut T
pub unsafe fn ivar_ptr<T: Encode>(&self, name: &str) -> *mut T
Returns a pointer to the instance variable / ivar with the given name.
This is similar to UnsafeCell::get, see that for more information
on what is and isn’t safe to do.
Usually you will have defined the instance variable yourself with
ClassBuilder::add_ivar, the type of the ivar T must match the
type used in that.
Attempting to access or modify private implementation details of a class that you do no control using this is not supported, and may invoke undefined behaviour.
Library implementors are strongly encouraged to expose a safe interface to the ivar.
Panics
May panic if the object has no ivar with the given name. May also
panic if the type encoding of the ivar differs from the type encoding
of T.
This should purely seen as help while debugging and is not guaranteed
(e.g. it may be disabled when debug_assertions are off).
Safety
The object must have an instance variable with the given name, and it
must be of type T. Any invariants that the object have assumed about
the value of the instance variable must not be violated.
No thread syncronization is done on accesses to the variable, so you must ensure that any access to the returned pointer do not cause data races, and that Rust’s mutability rules are not otherwise violated.
sourcepub unsafe fn ivar<T: Encode>(&self, name: &str) -> &T
pub unsafe fn ivar<T: Encode>(&self, name: &str) -> &T
Returns a reference to the instance variable with the given name.
See AnyObject::ivar_ptr for more information, including on when
this panics.
Safety
The object must have an instance variable with the given name, and it
must be of type T.
No thread syncronization is done, so you must ensure that no other
thread is concurrently mutating the variable. This requirement can be
considered upheld if all mutation happens through
AnyObject::ivar_mut (since that takes &mut self).
sourcepub unsafe fn get_ivar<T: Encode>(&self, name: &str) -> &T
👎Deprecated: Use AnyObject::ivar instead.
pub unsafe fn get_ivar<T: Encode>(&self, name: &str) -> &T
AnyObject::ivar instead.sourcepub unsafe fn ivar_mut<T: Encode>(&mut self, name: &str) -> &mut T
pub unsafe fn ivar_mut<T: Encode>(&mut self, name: &str) -> &mut T
Returns a mutable reference to the ivar with the given name.
See AnyObject::ivar_ptr for more information, including on when
this panics.
Safety
The object must have an instance variable with the given name, and it
must be of type T.
This access happens through &mut self, which means we know it to be
the only reference, hence you do not need to do any work to ensure
that data races do not happen.
sourcepub unsafe fn get_mut_ivar<T: Encode>(&mut self, name: &str) -> &mut T
👎Deprecated: Use AnyObject::ivar_mut instead.
pub unsafe fn get_mut_ivar<T: Encode>(&mut self, name: &str) -> &mut T
AnyObject::ivar_mut instead.sourcepub unsafe fn set_ivar<T: Encode>(&mut self, name: &str, value: T)
pub unsafe fn set_ivar<T: Encode>(&mut self, name: &str, value: T)
Sets the value of the ivar with the given name.
This is a shorthand for AnyObject::ivar_mut, see that for more
information.
Safety
Same as AnyObject::ivar_mut.