Struct StrongPtr

pub struct StrongPtr(/* private fields */);

A pointer that strongly references an object, ensuring it won’t be deallocated.

Implementations

impl StrongPtr

pub unsafe fn new(ptr: *mut Object) -> Self

Constructs a StrongPtr to a newly created object that already has a +1 retain count. This will not retain the object. When dropped, the object will be released. Unsafe because the caller must ensure the given object pointer is valid.

Examples found in repository

examples/example.rs (line 23)

fn main() {
    // Get a class
    let cls = class!(NSObject);
    println!("NSObject size: {}", cls.instance_size());

    // Inspect its ivars
    println!("NSObject ivars:");
    for ivar in cls.instance_variables().iter() {
        println!("{}", ivar.name());
    }

    // Allocate an instance
    let obj = unsafe {
        let obj: *mut Object = msg_send![cls, alloc];
        let obj: *mut Object = msg_send![obj, init];
        StrongPtr::new(obj)
    };
    println!("NSObject address: {:p}", obj);

    // Access an ivar of the object
    let isa: *const Class = unsafe {
        *(**obj).get_ivar("isa")
    };
    println!("NSObject isa: {:?}", isa);

    // Inspect a method of the class
    let hash_sel = sel!(hash);
    let hash_method = cls.instance_method(hash_sel).unwrap();
    let hash_return = hash_method.return_type();
    println!("-[NSObject hash] return type: {:?}", hash_return);
    assert!(hash_return == usize::encode());

    // Invoke a method on the object
    let hash: usize = unsafe {
        msg_send![*obj, hash]
    };
    println!("NSObject hash: {}", hash);
}

pub unsafe fn retain(ptr: *mut Object) -> Self

Retains the given object and constructs a StrongPtr to it. When dropped, the object will be released. Unsafe because the caller must ensure the given object pointer is valid.

pub fn autorelease(self) -> *mut Object

Autoreleases self, meaning that the object is not immediately released, but will be when the autorelease pool is drained. A pointer to the object is returned, but its validity is no longer ensured.

pub fn weak(&self) -> WeakPtr

Returns a WeakPtr to self.

Trait Implementations

impl Clone for StrongPtr

fn clone(&self) -> StrongPtr

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Deref for StrongPtr

type Target = *mut Object

The resulting type after dereferencing.

fn deref(&self) -> &*mut Object

Dereferences the value.

impl Drop for StrongPtr

fn drop(&mut self)

Executes the destructor for this type.

impl Pointer for StrongPtr

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

Formats the value using the given formatter.