Struct objc2_foundation::NSObject

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

Implementations

impl NSObject

pub fn class() -> &'static Class

Get a reference to the Objective-C class NSObject.

impl NSObject

pub fn new() -> Id<Self, Owned>

pub fn hash_code(&self) -> usize

pub fn is_equal(&self, other: &NSObject) -> bool

pub fn description(&self) -> Id<NSString, Shared>

pub fn is_kind_of(&self, cls: &Class) -> bool

Methods from Deref<Target = Object>

pub fn class(&self) -> &Class

Dynamically find the class of this object.

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

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>(&self, name: &str) -> &T where
    T: Encode, 

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>(&self, name: &str) -> &T where
    T: Encode, 

👎 Deprecated:

Use Object::ivar instead.

Use Object::ivar instead.

Safety

See Object::ivar.

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

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>(&mut self, name: &str) -> &mut T where
    T: Encode, 

👎 Deprecated:

Use Object::ivar_mut instead.

Use Object::ivar_mut instead.

Safety

Same as Object::ivar_mut.

pub unsafe fn set_ivar<T>(&mut self, name: &str, value: T) where
    T: Encode, 

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, O: Ownership> AsMut<NSObject> for NSArray<T, O>

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

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

impl AsMut<NSObject> for NSAttributedString

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

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

impl AsMut<NSObject> for NSData

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

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

impl<K, V> AsMut<NSObject> for NSDictionary<K, V>

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

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

impl AsMut<NSObject> for NSException

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

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

impl<T, O: Ownership> AsMut<NSObject> for NSMutableArray<T, O>

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

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

impl AsMut<NSObject> for NSMutableAttributedString

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

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

impl AsMut<NSObject> for NSMutableData

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

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

impl AsMut<NSObject> for NSMutableString

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

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 AsMut<NSObject> for NSProcessInfo

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

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

impl AsMut<NSObject> for NSString

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

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

impl AsMut<NSObject> for NSThread

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

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

impl AsMut<NSObject> for NSUUID

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

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

impl<T> AsMut<NSObject> for NSValue<T>

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

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<T, O: Ownership> AsRef<NSObject> for NSArray<T, O>

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSObject> for NSAttributedString

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSObject> for NSData

fn as_ref(&self) -> &NSObject

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

impl<K, V> AsRef<NSObject> for NSDictionary<K, V>

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSObject> for NSException

fn as_ref(&self) -> &NSObject

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

impl<T, O: Ownership> AsRef<NSObject> for NSMutableArray<T, O>

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSObject> for NSMutableAttributedString

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSObject> for NSMutableData

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSObject> for NSMutableString

fn as_ref(&self) -> &NSObject

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 AsRef<NSObject> for NSProcessInfo

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSObject> for NSString

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSObject> for NSThread

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSObject> for NSUUID

fn as_ref(&self) -> &NSObject

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

impl<T> AsRef<NSObject> for NSValue<T>

fn as_ref(&self) -> &NSObject

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<T, O: Ownership> Borrow<NSObject> for NSArray<T, O>

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSAttributedString

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSData

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl<K, V> Borrow<NSObject> for NSDictionary<K, V>

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSException

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl<T, O: Ownership> Borrow<NSObject> for NSMutableArray<T, O>

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSMutableAttributedString

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSMutableData

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSMutableString

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSProcessInfo

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSString

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSThread

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSUUID

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl<T> Borrow<NSObject> for NSValue<T>

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<Object> for NSObject

fn borrow(&self) -> &Object

Immutably borrows from an owned value.

impl<T, O: Ownership> BorrowMut<NSObject> for NSArray<T, O>

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

Mutably borrows from an owned value.

impl BorrowMut<NSObject> for NSAttributedString

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

Mutably borrows from an owned value.

impl BorrowMut<NSObject> for NSData

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

Mutably borrows from an owned value.

impl<K, V> BorrowMut<NSObject> for NSDictionary<K, V>

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

Mutably borrows from an owned value.

impl BorrowMut<NSObject> for NSException

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

Mutably borrows from an owned value.

impl<T, O: Ownership> BorrowMut<NSObject> for NSMutableArray<T, O>

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

Mutably borrows from an owned value.

impl BorrowMut<NSObject> for NSMutableAttributedString

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

Mutably borrows from an owned value.

impl BorrowMut<NSObject> for NSMutableData

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

Mutably borrows from an owned value.

impl BorrowMut<NSObject> for NSMutableString

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

Mutably borrows from an owned value.

impl BorrowMut<NSObject> for NSProcessInfo

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

Mutably borrows from an owned value.

impl BorrowMut<NSObject> for NSString

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

Mutably borrows from an owned value.

impl BorrowMut<NSObject> for NSThread

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

Mutably borrows from an owned value.

impl BorrowMut<NSObject> for NSUUID

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

Mutably borrows from an owned value.

impl<T> BorrowMut<NSObject> for NSValue<T>

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

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

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

Formats the value using the given formatter.

impl DefaultId for NSObject

type Ownership = Owned

Indicates whether the default value is mutable or immutable.

fn default_id() -> Id<Self, Self::Ownership>

The default Id for a type.

impl Deref for NSObject

type Target = Object

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, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<NSObject> 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 !=.

impl RefEncode for NSObject

const ENCODING_REF: Encoding<'static> = <Object as crate::objc2::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