Struct objc2::runtime::Object

#[repr(C)]
pub struct Object(_);

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

Id<Object, _> is equivalent to Objective-C’s id.

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.

Implementations

impl Object

pub fn class(&self) -> &Class

Dynamically find the class of this object.

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.

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

Returns a reference to the instance variable with the given name.

See Object::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 Object::ivar_mut (since that takes &mut self).

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

👎Deprecated: Use Object::ivar instead.

Use Object::ivar instead.

Safety

See Object::ivar.

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

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

👎Deprecated: Use Object::ivar_mut instead.

Use Object::ivar_mut instead.

Safety

Same as Object::ivar_mut.

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 just a helpful shorthand for Object::ivar_mut, see that for more information.

Safety

Same as Object::ivar_mut.

Trait Implementations

impl<T: Message, O: Ownership> AsMut<Object> for NSArray<T, O>

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

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

impl AsMut<Object> for NSAttributedString

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

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

impl AsMut<Object> for NSBundle

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

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

impl AsMut<Object> for NSData

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

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

impl<K: Message, V: Message> AsMut<Object> for NSDictionary<K, V>

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

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

impl AsMut<Object> for NSError

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

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

impl AsMut<Object> for NSException

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

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

impl<T: Message, O: Ownership> AsMut<Object> for NSMutableArray<T, O>

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

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

impl AsMut<Object> for NSMutableAttributedString

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

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

impl AsMut<Object> for NSMutableData

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

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

impl<K: Message, V: Message> AsMut<Object> for NSMutableDictionary<K, V>

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

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

impl<T: Message, O: Ownership> AsMut<Object> for NSMutableSet<T, O>

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

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

impl AsMut<Object> for NSMutableString

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

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

impl AsMut<Object> for NSNumber

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

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

impl AsMut<Object> for NSObject

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

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

impl AsMut<Object> for NSProcessInfo

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

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

impl<T: Message, O: Ownership> AsMut<Object> for NSSet<T, O>

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

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

impl AsMut<Object> for NSString

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

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

impl AsMut<Object> for NSThread

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

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

impl AsMut<Object> for NSUUID

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

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

impl AsMut<Object> for NSValue

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

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

impl AsRef<Object> for Exception

fn as_ref(&self) -> &Object

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

impl<T: Message, O: Ownership> AsRef<Object> for NSArray<T, O>

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for NSAttributedString

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for NSBundle

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for NSData

fn as_ref(&self) -> &Object

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

impl<K: Message, V: Message> AsRef<Object> for NSDictionary<K, V>

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for NSError

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for NSException

fn as_ref(&self) -> &Object

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

impl<T: Message, O: Ownership> AsRef<Object> for NSMutableArray<T, O>

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for NSMutableAttributedString

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for NSMutableData

fn as_ref(&self) -> &Object

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

impl<K: Message, V: Message> AsRef<Object> for NSMutableDictionary<K, V>

fn as_ref(&self) -> &Object

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

impl<T: Message, O: Ownership> AsRef<Object> for NSMutableSet<T, O>

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for NSMutableString

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for NSNumber

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for NSObject

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for NSProcessInfo

fn as_ref(&self) -> &Object

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

impl<T: Message, O: Ownership> AsRef<Object> for NSSet<T, O>

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for NSString

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for NSThread

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for NSUUID

fn as_ref(&self) -> &Object

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

impl AsRef<Object> for NSValue

fn as_ref(&self) -> &Object

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

impl<T: Message, O: Ownership> Borrow<Object> for NSArray<T, O>

fn borrow(&self) -> &Object

Immutably borrows from an owned value.

impl Borrow<Object> for NSAttributedString

fn borrow(&self) -> &Object

Immutably borrows from an owned value.

impl Borrow<Object> for NSBundle

fn borrow(&self) -> &Object

Immutably borrows from an owned value.

impl Borrow<Object> for NSData

fn borrow(&self) -> &Object

Immutably borrows from an owned value.

impl<K: Message, V: Message> Borrow<Object> for NSDictionary<K, V>

fn borrow(&self) -> &Object

Immutably borrows from an owned value.

impl Borrow<Object> for NSError

fn borrow(&self) -> &Object

Immutably borrows from an owned value.

impl Borrow<Object> for NSException

fn borrow(&self) -> &Object

Immutably borrows from an owned value.

impl<T: Message, O: Ownership> Borrow<Object> for NSMutableArray<T, O>

fn borrow(&self) -> &Object

Immutably borrows from an owned value.

impl Borrow<Object> for NSMutableAttributedString

fn borrow(&self) -> &Object

Immutably borrows from an owned value.

impl Borrow<Object> for NSMutableData

fn borrow(&self) -> &Object

Immutably borrows from an owned value.

impl<K: Message, V: Message> Borrow<Object> for NSMutableDictionary<K, V>

fn borrow(&self) -> &Object

Immutably borrows from an owned value.

impl<T: Message, O: Ownership> Borrow<Object> for NSMutableSet<T, O>

fn borrow(&self) -> &Object

Immutably borrows from an owned value.

impl Borrow<Object> for NSMutableString

fn borrow(&self) -> &Object

Immutably borrows from an owned value.

impl Borrow<Object> for NSNumber

fn borrow(&self) -> &Object

Immutably borrows from an owned value.

impl Borrow<Object> for NSObject

fn borrow(&self) -> &Object

Immutably borrows from an owned value.

impl Borrow<Object> for NSProcessInfo

fn borrow(&self) -> &Object

Immutably borrows from an owned value.

impl<T: Message, O: Ownership> Borrow<Object> for NSSet<T, O>

fn borrow(&self) -> &Object

Immutably borrows from an owned value.

impl Borrow<Object> for NSString

fn borrow(&self) -> &Object

Immutably borrows from an owned value.

impl Borrow<Object> for NSThread

fn borrow(&self) -> &Object

Immutably borrows from an owned value.

impl Borrow<Object> for NSUUID

fn borrow(&self) -> &Object

Immutably borrows from an owned value.

impl Borrow<Object> for NSValue

fn borrow(&self) -> &Object

Immutably borrows from an owned value.

impl<T: Message, O: Ownership> BorrowMut<Object> for NSArray<T, O>

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

Mutably borrows from an owned value.

impl BorrowMut<Object> for NSAttributedString

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

Mutably borrows from an owned value.

impl BorrowMut<Object> for NSBundle

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

Mutably borrows from an owned value.

impl BorrowMut<Object> for NSData

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

Mutably borrows from an owned value.

impl<K: Message, V: Message> BorrowMut<Object> for NSDictionary<K, V>

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

Mutably borrows from an owned value.

impl BorrowMut<Object> for NSError

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

Mutably borrows from an owned value.

impl BorrowMut<Object> for NSException

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

Mutably borrows from an owned value.

impl<T: Message, O: Ownership> BorrowMut<Object> for NSMutableArray<T, O>

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

Mutably borrows from an owned value.

impl BorrowMut<Object> for NSMutableAttributedString

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

Mutably borrows from an owned value.

impl BorrowMut<Object> for NSMutableData

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

Mutably borrows from an owned value.

impl<K: Message, V: Message> BorrowMut<Object> for NSMutableDictionary<K, V>

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

Mutably borrows from an owned value.

impl<T: Message, O: Ownership> BorrowMut<Object> for NSMutableSet<T, O>

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

Mutably borrows from an owned value.

impl BorrowMut<Object> for NSMutableString

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

Mutably borrows from an owned value.

impl BorrowMut<Object> for NSNumber

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

Mutably borrows from an owned value.

impl BorrowMut<Object> for NSObject

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

Mutably borrows from an owned value.

impl BorrowMut<Object> for NSProcessInfo

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

Mutably borrows from an owned value.

impl<T: Message, O: Ownership> BorrowMut<Object> for NSSet<T, O>

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

Mutably borrows from an owned value.

impl BorrowMut<Object> for NSString

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

Mutably borrows from an owned value.

impl BorrowMut<Object> for NSThread

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

Mutably borrows from an owned value.

impl BorrowMut<Object> for NSUUID

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

Mutably borrows from an owned value.

impl BorrowMut<Object> for NSValue

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

Mutably borrows from an owned value.

impl Debug for Object

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

Formats the value using the given formatter.

impl RefEncode for Object

const ENCODING_REF: Encoding = Encoding::Object

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

impl Message for Object