Struct Id

pub struct Id<T, O = Owned> { /* private fields */ }

A pointer type for Objective-C’s reference counted objects.

The object of an Id is retained and sent a release message when the Id is dropped.

An Id may be either Owned or Shared, represented by the types Id and ShareId, respectively. If owned, there are no other references to the object and the Id can be mutably dereferenced. ShareId, however, can only be immutably dereferenced because there may be other references to the object, but a ShareId can be cloned to provide more references to the object. An owned Id can be “downgraded” freely to a ShareId, but there is no way to safely upgrade back.

Implementations

impl<T, O> Id<T, O>

where T: Message, O: Ownership,

pub unsafe fn from_ptr(ptr: *mut T) -> Id<T, O>

Constructs an Id from a pointer to an unretained object and retains it. Panics if the pointer is null. Unsafe because the pointer must be to a valid object and the caller must ensure the ownership is correct.

pub unsafe fn from_retained_ptr(ptr: *mut T) -> Id<T, O>

Constructs an Id from a pointer to a retained object; this won’t retain the pointer, so the caller must ensure the object has a +1 retain count. Panics if the pointer is null. Unsafe because the pointer must be to a valid object and the caller must ensure the ownership is correct.

impl<T> Id<T, Owned>

where T: Message,

pub fn share(self) -> ShareId<T>

“Downgrade” an owned Id to a ShareId, allowing it to be cloned.

Trait Implementations

impl<T> Clone for Id<T, Shared>

where T: Message,

fn clone(&self) -> ShareId<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T, O> Debug for Id<T, O>

where T: Debug,

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

Formats the value using the given formatter.

impl<T, O> Deref for Id<T, O>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T> DerefMut for Id<T, Owned>

fn deref_mut(&mut self) -> &mut T

Mutably dereferences the value.

impl<T, O> Hash for Id<T, O>

where T: Hash,

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T, O> PartialEq for Id<T, O>

where T: PartialEq,

fn eq(&self, other: &Id<T, O>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Id<T, O>) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T, O> Pointer for Id<T, O>

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

Formats the value using the given formatter.

impl<T, O> Eq for Id<T, O>

where T: Eq,

impl<T> Send for Id<T, Owned>

where T: Send,

impl<T> Send for Id<T, Shared>

where T: Sync,

impl<T, O> Sync for Id<T, O>

where T: Sync,