#[repr(C)]pub struct Object(_);
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
).
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
sourceimpl Object
impl Object
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 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
).
sourcepub unsafe fn get_ivar<T: Encode>(&self, name: &str) -> &T
👎Deprecated: Use Object::ivar
instead.
pub unsafe fn get_ivar<T: Encode>(&self, name: &str) -> &T
Use Object::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 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.
sourcepub unsafe fn get_mut_ivar<T: Encode>(&mut self, name: &str) -> &mut T
👎Deprecated: Use Object::ivar_mut
instead.
pub unsafe fn get_mut_ivar<T: Encode>(&mut self, name: &str) -> &mut T
Use Object::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 just a helpful shorthand for Object::ivar_mut
, see that
for more information.
Safety
Same as Object::ivar_mut
.
Trait Implementations
sourceimpl AsMut<Object> for NSAttributedString
impl AsMut<Object> for NSAttributedString
sourceimpl AsMut<Object> for NSException
impl AsMut<Object> for NSException
sourceimpl AsMut<Object> for NSMutableAttributedString
impl AsMut<Object> for NSMutableAttributedString
sourceimpl AsMut<Object> for NSMutableData
impl AsMut<Object> for NSMutableData
sourceimpl AsMut<Object> for NSMutableString
impl AsMut<Object> for NSMutableString
sourceimpl AsMut<Object> for NSProcessInfo
impl AsMut<Object> for NSProcessInfo
sourceimpl AsRef<Object> for NSAttributedString
impl AsRef<Object> for NSAttributedString
sourceimpl AsRef<Object> for NSException
impl AsRef<Object> for NSException
sourceimpl AsRef<Object> for NSMutableAttributedString
impl AsRef<Object> for NSMutableAttributedString
sourceimpl AsRef<Object> for NSMutableData
impl AsRef<Object> for NSMutableData
sourceimpl AsRef<Object> for NSMutableString
impl AsRef<Object> for NSMutableString
sourceimpl AsRef<Object> for NSProcessInfo
impl AsRef<Object> for NSProcessInfo
sourceimpl Borrow<Object> for NSAttributedString
impl Borrow<Object> for NSAttributedString
sourceimpl Borrow<Object> for NSException
impl Borrow<Object> for NSException
sourceimpl Borrow<Object> for NSMutableAttributedString
impl Borrow<Object> for NSMutableAttributedString
sourceimpl Borrow<Object> for NSMutableData
impl Borrow<Object> for NSMutableData
sourceimpl Borrow<Object> for NSMutableString
impl Borrow<Object> for NSMutableString
sourceimpl Borrow<Object> for NSProcessInfo
impl Borrow<Object> for NSProcessInfo
sourceimpl<T: Message, O: Ownership> BorrowMut<Object> for NSArray<T, O>
impl<T: Message, O: Ownership> BorrowMut<Object> for NSArray<T, O>
sourcefn borrow_mut(&mut self) -> &mut Object
fn borrow_mut(&mut self) -> &mut Object
Mutably borrows from an owned value. Read more
sourceimpl BorrowMut<Object> for NSAttributedString
impl BorrowMut<Object> for NSAttributedString
sourcefn borrow_mut(&mut self) -> &mut Object
fn borrow_mut(&mut self) -> &mut Object
Mutably borrows from an owned value. Read more
sourceimpl BorrowMut<Object> for NSBundle
impl BorrowMut<Object> for NSBundle
sourcefn borrow_mut(&mut self) -> &mut Object
fn borrow_mut(&mut self) -> &mut Object
Mutably borrows from an owned value. Read more
sourceimpl BorrowMut<Object> for NSData
impl BorrowMut<Object> for NSData
sourcefn borrow_mut(&mut self) -> &mut Object
fn borrow_mut(&mut self) -> &mut Object
Mutably borrows from an owned value. Read more
sourceimpl<K: Message, V: Message> BorrowMut<Object> for NSDictionary<K, V>
impl<K: Message, V: Message> BorrowMut<Object> for NSDictionary<K, V>
sourcefn borrow_mut(&mut self) -> &mut Object
fn borrow_mut(&mut self) -> &mut Object
Mutably borrows from an owned value. Read more
sourceimpl BorrowMut<Object> for NSError
impl BorrowMut<Object> for NSError
sourcefn borrow_mut(&mut self) -> &mut Object
fn borrow_mut(&mut self) -> &mut Object
Mutably borrows from an owned value. Read more
sourceimpl BorrowMut<Object> for NSException
impl BorrowMut<Object> for NSException
sourcefn borrow_mut(&mut self) -> &mut Object
fn borrow_mut(&mut self) -> &mut Object
Mutably borrows from an owned value. Read more
sourceimpl<T: Message, O: Ownership> BorrowMut<Object> for NSMutableArray<T, O>
impl<T: Message, O: Ownership> BorrowMut<Object> for NSMutableArray<T, O>
sourcefn borrow_mut(&mut self) -> &mut Object
fn borrow_mut(&mut self) -> &mut Object
Mutably borrows from an owned value. Read more
sourceimpl BorrowMut<Object> for NSMutableAttributedString
impl BorrowMut<Object> for NSMutableAttributedString
sourcefn borrow_mut(&mut self) -> &mut Object
fn borrow_mut(&mut self) -> &mut Object
Mutably borrows from an owned value. Read more
sourceimpl BorrowMut<Object> for NSMutableData
impl BorrowMut<Object> for NSMutableData
sourcefn borrow_mut(&mut self) -> &mut Object
fn borrow_mut(&mut self) -> &mut Object
Mutably borrows from an owned value. Read more
sourceimpl<K: Message, V: Message> BorrowMut<Object> for NSMutableDictionary<K, V>
impl<K: Message, V: Message> BorrowMut<Object> for NSMutableDictionary<K, V>
sourcefn borrow_mut(&mut self) -> &mut Object
fn borrow_mut(&mut self) -> &mut Object
Mutably borrows from an owned value. Read more
sourceimpl<T: Message, O: Ownership> BorrowMut<Object> for NSMutableSet<T, O>
impl<T: Message, O: Ownership> BorrowMut<Object> for NSMutableSet<T, O>
sourcefn borrow_mut(&mut self) -> &mut Object
fn borrow_mut(&mut self) -> &mut Object
Mutably borrows from an owned value. Read more
sourceimpl BorrowMut<Object> for NSMutableString
impl BorrowMut<Object> for NSMutableString
sourcefn borrow_mut(&mut self) -> &mut Object
fn borrow_mut(&mut self) -> &mut Object
Mutably borrows from an owned value. Read more
sourceimpl BorrowMut<Object> for NSNumber
impl BorrowMut<Object> for NSNumber
sourcefn borrow_mut(&mut self) -> &mut Object
fn borrow_mut(&mut self) -> &mut Object
Mutably borrows from an owned value. Read more
sourceimpl BorrowMut<Object> for NSObject
impl BorrowMut<Object> for NSObject
sourcefn borrow_mut(&mut self) -> &mut Object
fn borrow_mut(&mut self) -> &mut Object
Mutably borrows from an owned value. Read more
sourceimpl BorrowMut<Object> for NSProcessInfo
impl BorrowMut<Object> for NSProcessInfo
sourcefn borrow_mut(&mut self) -> &mut Object
fn borrow_mut(&mut self) -> &mut Object
Mutably borrows from an owned value. Read more
sourceimpl<T: Message, O: Ownership> BorrowMut<Object> for NSSet<T, O>
impl<T: Message, O: Ownership> BorrowMut<Object> for NSSet<T, O>
sourcefn borrow_mut(&mut self) -> &mut Object
fn borrow_mut(&mut self) -> &mut Object
Mutably borrows from an owned value. Read more
sourceimpl BorrowMut<Object> for NSString
impl BorrowMut<Object> for NSString
sourcefn borrow_mut(&mut self) -> &mut Object
fn borrow_mut(&mut self) -> &mut Object
Mutably borrows from an owned value. Read more
sourceimpl BorrowMut<Object> for NSThread
impl BorrowMut<Object> for NSThread
sourcefn borrow_mut(&mut self) -> &mut Object
fn borrow_mut(&mut self) -> &mut Object
Mutably borrows from an owned value. Read more
sourceimpl BorrowMut<Object> for NSUUID
impl BorrowMut<Object> for NSUUID
sourcefn borrow_mut(&mut self) -> &mut Object
fn borrow_mut(&mut self) -> &mut Object
Mutably borrows from an owned value. Read more
sourceimpl BorrowMut<Object> for NSValue
impl BorrowMut<Object> for NSValue
sourcefn borrow_mut(&mut self) -> &mut Object
fn borrow_mut(&mut self) -> &mut Object
Mutably borrows from an owned value. Read more
sourceimpl RefEncode for Object
impl RefEncode for Object
sourceconst ENCODING_REF: Encoding = Encoding::Object
const ENCODING_REF: Encoding = Encoding::Object
The Objective-C type-encoding for a reference of this type. Read more
impl Message for Object
Auto Trait Implementations
impl !RefUnwindSafe for Object
impl !Send for Object
impl !Sync for Object
impl !Unpin for Object
impl !UnwindSafe for Object
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more