Struct NSArray

#[repr(C)]
pub struct NSArray<ObjectType = AnyObject>
where
    ObjectType: ?Sized,
{ /* private fields */ }

Implementations

impl<T> NSArray<T>

where T: Message,

pub fn from_vec(vec: Vec<Retained<T>>) -> Retained<NSArray<T>>

pub fn from_id_slice(slice: &[Retained<T>]) -> Retained<NSArray<T>>

where T: IsIdCloneable,

pub fn from_slice(slice: &[&T]) -> Retained<NSArray<T>>

where T: IsRetainable,

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

pub fn to_vec_retained(&self) -> Vec<Retained<T>>

where T: IsIdCloneable,

impl<T> NSArray<T>

where T: Message,

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

impl<T> NSArray<T>

where T: Message,

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

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

where T: IsIdCloneable,

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

where T: IsMutable,

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

pub fn first_retained(&self) -> Option<Retained<T>>

where T: IsIdCloneable,

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

where T: IsMutable,

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

pub fn last_retained(&self) -> Option<Retained<T>>

where T: IsIdCloneable,

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

where T: IsMutable,

impl<T> NSArray<T>

where T: Message,

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

impl<ObjectType> NSArray<ObjectType>

where ObjectType: Message,

pub fn count(&self) -> usize

pub unsafe fn objectAtIndex(&self, index: usize) -> Retained<ObjectType>

pub fn init( this: Allocated<NSArray<ObjectType>>, ) -> Retained<NSArray<ObjectType>>

pub unsafe fn initWithObjects_count( this: Allocated<NSArray<ObjectType>>, objects: *mut NonNull<ObjectType>, cnt: usize, ) -> Retained<NSArray<ObjectType>>

pub unsafe fn initWithCoder( this: Allocated<NSArray<ObjectType>>, coder: &NSCoder, ) -> Option<Retained<NSArray<ObjectType>>>

impl<ObjectType> NSArray<ObjectType>

where ObjectType: Message,

Methods declared on superclass NSObject

pub fn new() -> Retained<NSArray<ObjectType>>

impl<ObjectType> NSArray<ObjectType>

where ObjectType: Message,

NSExtendedArray

pub unsafe fn arrayByAddingObject( &self, an_object: &ObjectType, ) -> Retained<NSArray<ObjectType>>

pub unsafe fn arrayByAddingObjectsFromArray( &self, other_array: &NSArray<ObjectType>, ) -> Retained<NSArray<ObjectType>>

pub unsafe fn componentsJoinedByString( &self, separator: &NSString, ) -> Retained<NSString>

pub unsafe fn containsObject(&self, an_object: &ObjectType) -> bool

pub unsafe fn description(&self) -> Retained<NSString>

pub unsafe fn descriptionWithLocale( &self, locale: Option<&AnyObject>, ) -> Retained<NSString>

pub unsafe fn descriptionWithLocale_indent( &self, locale: Option<&AnyObject>, level: usize, ) -> Retained<NSString>

pub unsafe fn firstObjectCommonWithArray( &self, other_array: &NSArray<ObjectType>, ) -> Option<Retained<ObjectType>>

pub unsafe fn getObjects_range( &self, objects: NonNull<NonNull<ObjectType>>, range: NSRange, )

pub unsafe fn indexOfObject(&self, an_object: &ObjectType) -> usize

pub unsafe fn indexOfObject_inRange( &self, an_object: &ObjectType, range: NSRange, ) -> usize

pub unsafe fn indexOfObjectIdenticalTo(&self, an_object: &ObjectType) -> usize

pub unsafe fn indexOfObjectIdenticalTo_inRange( &self, an_object: &ObjectType, range: NSRange, ) -> usize

pub unsafe fn isEqualToArray(&self, other_array: &NSArray<ObjectType>) -> bool

pub unsafe fn firstObject(&self) -> Option<Retained<ObjectType>>

pub unsafe fn lastObject(&self) -> Option<Retained<ObjectType>>

pub unsafe fn sortedArrayHint(&self) -> Retained<NSData>

pub unsafe fn sortedArrayUsingFunction_context( &self, comparator: unsafe extern "C" fn(_: NonNull<ObjectType>, _: NonNull<ObjectType>, _: *mut c_void) -> isize, context: *mut c_void, ) -> Retained<NSArray<ObjectType>>

pub unsafe fn sortedArrayUsingFunction_context_hint( &self, comparator: unsafe extern "C" fn(_: NonNull<ObjectType>, _: NonNull<ObjectType>, _: *mut c_void) -> isize, context: *mut c_void, hint: Option<&NSData>, ) -> Retained<NSArray<ObjectType>>

pub unsafe fn sortedArrayUsingSelector( &self, comparator: Sel, ) -> Retained<NSArray<ObjectType>>

pub unsafe fn subarrayWithRange( &self, range: NSRange, ) -> Retained<NSArray<ObjectType>>

pub unsafe fn writeToURL_error( &self, url: &NSURL, ) -> Result<(), Retained<NSError>>

pub unsafe fn makeObjectsPerformSelector(&self, a_selector: Sel)

pub unsafe fn makeObjectsPerformSelector_withObject( &self, a_selector: Sel, argument: Option<&AnyObject>, )

pub unsafe fn objectAtIndexedSubscript( &self, idx: usize, ) -> Retained<ObjectType>

impl<ObjectType> NSArray<ObjectType>

where ObjectType: Message,

NSArrayCreation

pub unsafe fn array() -> Retained<NSArray<ObjectType>>

pub unsafe fn arrayWithObject( an_object: &ObjectType, ) -> Retained<NSArray<ObjectType>>

pub unsafe fn arrayWithObjects_count( objects: NonNull<NonNull<ObjectType>>, cnt: usize, ) -> Retained<NSArray<ObjectType>>

pub unsafe fn arrayWithArray( array: &NSArray<ObjectType>, ) -> Retained<NSArray<ObjectType>>

pub unsafe fn initWithArray( this: Allocated<NSArray<ObjectType>>, array: &NSArray<ObjectType>, ) -> Retained<NSArray<ObjectType>>

pub unsafe fn initWithArray_copyItems( this: Allocated<NSArray<ObjectType>>, array: &NSArray<ObjectType>, flag: bool, ) -> Retained<NSArray<ObjectType>>

pub unsafe fn initWithContentsOfURL_error( this: Allocated<NSArray<ObjectType>>, url: &NSURL, ) -> Result<Retained<NSArray<ObjectType>>, Retained<NSError>>

pub unsafe fn arrayWithContentsOfURL_error( url: &NSURL, ) -> Result<Retained<NSArray<ObjectType>>, Retained<NSError>>

impl<ObjectType> NSArray<ObjectType>

where ObjectType: Message,

This impl block contains no items.

NSArrayDiffing

impl<ObjectType> NSArray<ObjectType>

where ObjectType: Message,

NSDeprecated

pub unsafe fn getObjects(&self, objects: NonNull<NonNull<ObjectType>>)

👎Deprecated: Use -getObjects:range: instead

pub unsafe fn arrayWithContentsOfFile( path: &NSString, ) -> Option<Retained<NSArray<ObjectType>>>

👎Deprecated

pub unsafe fn arrayWithContentsOfURL( url: &NSURL, ) -> Option<Retained<NSArray<ObjectType>>>

👎Deprecated

pub unsafe fn initWithContentsOfFile( this: Allocated<NSArray<ObjectType>>, path: &NSString, ) -> Option<Retained<NSArray<ObjectType>>>

👎Deprecated

pub unsafe fn initWithContentsOfURL( this: Allocated<NSArray<ObjectType>>, url: &NSURL, ) -> Option<Retained<NSArray<ObjectType>>>

👎Deprecated

pub unsafe fn writeToFile_atomically( &self, path: &NSString, use_auxiliary_file: bool, ) -> bool

👎Deprecated

pub unsafe fn writeToURL_atomically( &self, url: &NSURL, atomically: bool, ) -> bool

👎Deprecated

Methods from Deref<Target = NSObject>

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

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

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Use Ivar::load instead.

Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

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

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load_mut instead.

Use Ivar::load_mut instead.

Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

Trait Implementations

impl<ObjectType> AsMut<AnyObject> for NSArray<ObjectType>

where ObjectType: Message + ?Sized,

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

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

impl<ObjectType> AsMut<NSArray<ObjectType>> for NSArray<ObjectType>

where ObjectType: Message + ?Sized,

fn as_mut(&mut self) -> &mut NSArray<ObjectType>

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

impl<ObjectType> AsMut<NSObject> for NSArray<ObjectType>

where ObjectType: Message + ?Sized,

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

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

impl<ObjectType> AsRef<AnyObject> for NSArray<ObjectType>

where ObjectType: Message + ?Sized,

fn as_ref(&self) -> &AnyObject

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

impl<ObjectType> AsRef<NSArray<ObjectType>> for NSArray<ObjectType>

where ObjectType: Message + ?Sized,

fn as_ref(&self) -> &NSArray<ObjectType>

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

impl<ObjectType> AsRef<NSObject> for NSArray<ObjectType>

where ObjectType: Message + ?Sized,

fn as_ref(&self) -> &NSObject

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

impl<ObjectType> Borrow<AnyObject> for NSArray<ObjectType>

where ObjectType: Message + ?Sized,

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl<ObjectType> Borrow<NSObject> for NSArray<ObjectType>

where ObjectType: Message + ?Sized,

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl<ObjectType> BorrowMut<AnyObject> for NSArray<ObjectType>

where ObjectType: Message + ?Sized,

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

Mutably borrows from an owned value.

impl<ObjectType> BorrowMut<NSObject> for NSArray<ObjectType>

where ObjectType: Message + ?Sized,

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

Mutably borrows from an owned value.

impl<ObjectType> ClassType for NSArray<ObjectType>

where ObjectType: Message + ?Sized,

const NAME: &'static str = "NSArray"

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

type Super = NSObject

The superclass of this class.

type Mutability = ImmutableWithMutableSubclass<NSMutableArray<ObjectType>>

Whether the type is mutable or immutable.

fn class() -> &'static AnyClass

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

fn as_super(&self) -> &<NSArray<ObjectType> as ClassType>::Super

Get an immutable reference to the superclass.

fn as_super_mut(&mut self) -> &mut <NSArray<ObjectType> as ClassType>::Super

Get a mutable reference to the superclass.

fn alloc() -> Allocated<Self>

where Self: Sized + IsAllocableAnyThread,

Allocate a new instance of the class.

impl<ObjectType> DefaultRetained for NSArray<ObjectType>

where ObjectType: Message,

fn default_id() -> Retained<NSArray<ObjectType>>

The default Retained for a type.

fn default_retained() -> Retained<Self>

The default Retained for a type.

impl<ObjectType> Deref for NSArray<ObjectType>

where ObjectType: Message + ?Sized,

type Target = NSObject

The resulting type after dereferencing.

fn deref(&self) -> &<NSArray<ObjectType> as Deref>::Target

Dereferences the value.

impl<ObjectType> DerefMut for NSArray<ObjectType>

where ObjectType: Message + ?Sized,

fn deref_mut(&mut self) -> &mut <NSArray<ObjectType> as Deref>::Target

Mutably dereferences the value.

impl<ObjectType> Hash for NSArray<ObjectType>

where ObjectType: Hash + ?Sized,

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> Index<usize> for NSArray<T>

where T: Message,

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T> IndexMut<usize> for NSArray<T>

where T: Message + IsMutable,

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

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

impl<ObjectType> PartialEq for NSArray<ObjectType>

where ObjectType: PartialEq + ?Sized,

fn eq(&self, other: &NSArray<ObjectType>) -> bool

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

fn ne(&self, other: &Rhs) -> bool

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

impl<ObjectType> RefEncode for NSArray<ObjectType>

where ObjectType: Message + ?Sized,

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

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

impl<'a, T> RetainedFromIterator<&'a T> for NSArray<T>

where T: Message + IsRetainable + 'a,

fn id_from_iter<I>(iter: I) -> Retained<NSArray<T>>

where I: IntoIterator<Item = &'a T>,

Creates an Retained from an iterator.

fn retained_from_iter<I>(iter: I) -> Retained<Self>

where I: IntoIterator<Item = T>,

Creates an Retained from an iterator.

impl<T> RetainedFromIterator<Retained<T>> for NSArray<T>

where T: Message,

fn id_from_iter<I>(iter: I) -> Retained<NSArray<T>>

where I: IntoIterator<Item = Retained<T>>,

Creates an Retained from an iterator.

fn retained_from_iter<I>(iter: I) -> Retained<Self>

where I: IntoIterator<Item = T>,

Creates an Retained from an iterator.

impl<T> ToOwned for NSArray<T>

where T: Message + IsIdCloneable,

type Owned = Retained<NSArray<T>>

The resulting type after obtaining ownership.

fn to_owned(&self) -> <NSArray<T> as ToOwned>::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<ObjectType> Eq for NSArray<ObjectType>

where ObjectType: Eq + ?Sized,

impl<ObjectType> Message for NSArray<ObjectType>

where ObjectType: Message + ?Sized,

impl<ObjectType> NSCoding for NSArray<ObjectType>

where ObjectType: NSCoding + ?Sized,

impl<ObjectType> NSCopying for NSArray<ObjectType>

where ObjectType: IsIdCloneable + ?Sized,

impl<ObjectType> NSMutableCopying for NSArray<ObjectType>

where ObjectType: IsIdCloneable + ?Sized,

impl<ObjectType> NSObjectProtocol for NSArray<ObjectType>

where ObjectType: ?Sized,

impl<ObjectType> NSSecureCoding for NSArray<ObjectType>

where ObjectType: NSSecureCoding + ?Sized,

impl<ObjectType> StructuralPartialEq for NSArray<ObjectType>

where ObjectType: ?Sized,