Struct objc2::foundation::NSArray

#[repr(C)]
pub struct NSArray<T: Message, O: Ownership = Shared> { /* private fields */ }

An immutable ordered collection of objects.

This is the Objective-C equivalent of a “boxed slice” (Box<[T]>), so effectively a Vec<T> where you can’t change the number of elements.

The type of the contained objects is described by the generic parameter T, and the ownership of the objects is described with the generic parameter O.

Ownership

While NSArray itself is immutable, i.e. the number of objects it contains can’t change, it is still possible to modify the contained objects themselves, if you know you’re the sole owner of them - quite similar to how you can modify elements in Box<[T]>.

To mutate the contained objects the ownership must be O = Owned. A summary of what the different “types” of arrays allow you to do can be found below. Array refers to either NSArray or NSMutableArray.

• Id<NSMutableArray<T, Owned>, Owned>: Allows you to mutate the objects, and the array itself.
• Id<NSMutableArray<T, Shared>, Owned>: Allows you to mutate the array itself, but not it’s contents.
• Id<NSArray<T, Owned>, Owned>: Allows you to mutate the objects, but not the array itself.
• Id<NSArray<T, Shared>, Owned>: Effectively the same as the below.
• Id<Array<T, Shared>, Shared>: Allows you to copy the array, but does not allow you to modify it in any way.
• Id<Array<T, Owned>, Shared>: Pretty useless compared to the others, avoid this.

See Apple’s documentation.

Implementations

impl<T: Message, O: Ownership> NSArray<T, O>

Generic creation methods.

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

Get an empty array.

pub fn from_vec(vec: Vec<Id<T, O>>) -> Id<Self, O>

impl<T: Message> NSArray<T, Shared>

Creation methods that produce shared arrays.

pub fn from_slice(slice: &[Id<T, Shared>]) -> Id<Self, Shared>

impl<T: Message, O: Ownership> NSArray<T, O>

Generic accessor methods.

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn get(&self, index: usize) -> Option<&T>

pub fn first(&self) -> Option<&T>

pub fn last(&self) -> Option<&T>

pub fn iter(&self) -> NSEnumerator<'_, T>

pub fn objects_in_range(&self, range: Range<usize>) -> Vec<&T>

pub fn to_vec(&self) -> Vec<&T>

pub fn into_vec(array: Id<Self, Owned>) -> Vec<Id<T, O>>

impl<T: Message> NSArray<T, Shared>

Accessor methods that work on shared arrays.

pub fn get_retained(&self, index: usize) -> Id<T, Shared>

pub fn to_shared_vec(&self) -> Vec<Id<T, Shared>>

impl<T: Message> NSArray<T, Owned>

Accessor methods that work on owned arrays.

pub fn get_mut(&mut self, index: usize) -> Option<&mut T>

pub fn first_mut(&mut self) -> Option<&mut T>

pub fn last_mut(&mut self) -> Option<&mut T>

Methods from Deref<Target = NSObject>

pub fn is_kind_of<T: ClassType>(&self) -> bool

Check if the object is an instance of the class, or one of it’s subclasses.

See Apple’s documentation for more details on what you may (and what you may not) do with this information.

Methods from Deref<Target = Object>

pub fn class(&self) -> &Class

Dynamically find the class of this object.

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.

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).

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

👎Deprecated: Use Object::ivar instead.

Use Object::ivar instead.

Safety

See Object::ivar.

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.

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

👎Deprecated: Use Object::ivar_mut instead.

Use Object::ivar_mut instead.

Safety

Same as Object::ivar_mut.

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

impl<T: Message, O: Ownership> AsMut<NSArray<T, O>> for NSArray<T, O>

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

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

impl<T: Message, O: Ownership> AsMut<NSArray<T, O>> for NSMutableArray<T, O>

fn as_mut(&mut self) -> &mut NSArray<T, O>

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

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

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

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

impl<T: Message, O: Ownership> AsRef<NSArray<T, O>> for NSArray<T, O>

fn as_ref(&self) -> &Self

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

impl<T: Message, O: Ownership> AsRef<NSArray<T, O>> for NSMutableArray<T, O>

fn as_ref(&self) -> &NSArray<T, O>

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

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

fn as_ref(&self) -> &Object

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

impl<T: Message, O: Ownership> Borrow<NSArray<T, O>> for NSMutableArray<T, O>

fn borrow(&self) -> &NSArray<T, O>

Immutably borrows from an owned value.

impl<T: Message, O: Ownership> Borrow<NSObject> for NSArray<T, O>

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl<T: Message, O: Ownership> Borrow<Object> for NSArray<T, O>

fn borrow(&self) -> &Object

Immutably borrows from an owned value.

impl<T: Message, O: Ownership> BorrowMut<NSArray<T, O>> for NSMutableArray<T, O>

fn borrow_mut(&mut self) -> &mut NSArray<T, O>

Mutably borrows from an owned value.

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

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

Mutably borrows from an owned value.

impl<T: Message, O: Ownership> BorrowMut<Object> for NSArray<T, O>

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

Mutably borrows from an owned value.

impl<T: Message, O: Ownership> ClassType for NSArray<T, O>

type Super = NSObject

The superclass of this class.

const NAME: &'static str = _

The name of the Objective-C class that this type represents.

fn class() -> &'static Class

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

fn as_super_mut(&mut self) -> &mut Self::Super

Get a mutable reference to the superclass.

impl<T: Debug + Message, O: Ownership> Debug for NSArray<T, O>

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

Formats the value using the given formatter.

impl<T: Message, O: Ownership> DefaultId for NSArray<T, O>

type Ownership = Shared

Indicates whether the default value is mutable or immutable.

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

The default Id for a type.

impl<T: Message, O: Ownership> Deref for NSArray<T, O>

type Target = NSObject

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: Message, O: Ownership> DerefMut for NSArray<T, O>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T: Hash + Message, O: Hash + Ownership> Hash for NSArray<T, O>

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Message, O: Ownership> Index<usize> for NSArray<T, O>

type Output = T

The returned type after indexing.

fn index(&self, index: usize) -> &T

Performs the indexing (container[index]) operation.

impl<T: Message> IndexMut<usize> for NSArray<T, Owned>

fn index_mut(&mut self, index: usize) -> &mut T

Performs the mutable indexing (container[index]) operation.

impl<'a, T: Message, O: Ownership> IntoIterator for &'a NSArray<T, O>

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = NSFastEnumerator<'a, NSArray<T, O>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: Message> NSCopying for NSArray<T, Shared>

This is implemented as a shallow copy.

As such, it is only possible when the array’s contents are Shared.

type Ownership = Shared

Indicates whether the type is mutable or immutable.

type Output = NSArray<T, Shared>

The output type.

fn copy(&self) -> Id<Self::Output, Self::Ownership>

impl<T: Message, O: Ownership> NSFastEnumeration for NSArray<T, O>

type Item = T

fn iter_fast(&self) -> NSFastEnumerator<'_, Self>

impl<T: Message> NSMutableCopying for NSArray<T, Shared>

This is implemented as a shallow copy.

type Output = NSMutableArray<T, Shared>

TODO

fn mutable_copy(&self) -> Id<Self::Output, Owned>

impl<T: PartialEq + Message, O: PartialEq + Ownership> PartialEq<NSArray<T, O>> for NSArray<T, O>

fn eq(&self, other: &NSArray<T, O>) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Message, O: Ownership> RefEncode for NSArray<T, O>

const ENCODING_REF: Encoding = <NSObject as crate::RefEncode>::ENCODING_REF

The Objective-C type-encoding for a reference of this type.

impl<T: Message> ToOwned for NSArray<T, Shared>

type Owned = Id<NSArray<T, Shared>, Shared>

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.

impl<T: Eq + Message, O: Eq + Ownership> Eq for NSArray<T, O>

impl<T: Message, O: Ownership> Message for NSArray<T, O>

impl<T: Message + RefUnwindSafe, O: Ownership> RefUnwindSafe for NSArray<T, O>

impl<T: Message + Send> Send for NSArray<T, Owned>

impl<T: Message + Sync + Send> Send for NSArray<T, Shared>

impl<T: Message, O: Ownership> StructuralEq for NSArray<T, O>

impl<T: Message, O: Ownership> StructuralPartialEq for NSArray<T, O>

impl<T: Message + Sync> Sync for NSArray<T, Owned>

impl<T: Message + Sync + Send> Sync for NSArray<T, Shared>

impl<T: Message + UnwindSafe> UnwindSafe for NSArray<T, Owned>

impl<T: Message + RefUnwindSafe> UnwindSafe for NSArray<T, Shared>