Struct cacao::foundation::NSArray

pub struct NSArray(pub Id<Object>);

A wrapper for NSArray that makes common operations in our framework a bit easier to handle and reason about. This also provides a central place to look at replacing with CFArray if ever deemed necessary (unlikely, given how much Apple has optimized the Foundation classes, but still…).

Tuple Fields

0: Id<Object>

Implementations

impl NSArray

pub fn new(objects: &[id]) -> Self

Given a set of Objects, creates and retains an NSArray that holds them.

pub fn retain(array: id) -> Self

In some cases, we’re vended an NSArray by the system that we need to call retain on. This handles that case.

pub fn from_retained(array: id) -> Self

In some cases, we’re vended an NSArray by the system, and it’s ideal to not retain that. This handles that edge case.

pub fn count(&self) -> usize

Returns the count (len() equivalent) for the backing NSArray.

pub fn map<T, F: Fn(id) -> T>(&self, transform: F) -> Vec<T>

A helper method for mapping over the backing NSArray items and producing a Rust Vec<T>. Often times we need to map in this framework to convert between Rust types, so isolating this out makes life much easier.

Methods from Deref<Target = Object>

pub fn class(&self) -> &Class

Returns the class of self.

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

Returns a reference to the ivar of self with the given name. Panics if self has no ivar with the given name. Unsafe because the caller must ensure that the ivar is actually of type T.

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

Returns a mutable reference to the ivar of self with the given name. Panics if self has no ivar with the given name. Unsafe because the caller must ensure that the ivar is actually of type T.

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

Sets the value of the ivar of self with the given name. Panics if self has no ivar with the given name. Unsafe because the caller must ensure that the ivar is actually of type T.

Trait Implementations

impl Debug for NSArray

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

Formats the value using the given formatter.

impl Deref for NSArray

fn deref(&self) -> &Object

Derefs to the underlying Objective-C Object.

type Target = Object

The resulting type after dereferencing.

impl DerefMut for NSArray

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

Derefs to the underlying Objective-C Object.

impl From<NSArray> for id

fn from(array: NSArray) -> Self

Consumes and returns the pointer to the underlying NSArray.

impl From<Vec<&Object, Global>> for NSArray

fn from(objects: Vec<&Object>) -> Self

Given a set of Objects, creates an NSArray that holds them.

impl From<Vec<*mut Object, Global>> for NSArray

fn from(objects: Vec<id>) -> Self

Given a set of *mut Objects, creates an NSArray that holds them.