Struct NSMutableArray

Source
#[repr(C)]
pub struct NSMutableArray<ObjectType: ?Sized = AnyObject> { /* private fields */ }
Available on crate feature NSArray only.
Expand description

************** Mutable Array ***************

See also Apple’s documentation

Implementations§

Source§

impl<ObjectType: Message> NSMutableArray<ObjectType>

Convenience creation methods.

Source

pub fn from_slice(slice: &[&ObjectType]) -> Retained<Self>

Source

pub fn from_retained_slice(slice: &[Retained<ObjectType>]) -> Retained<Self>

Source§

impl<ObjectType: Message> NSMutableArray<ObjectType>

Convenience mutation methods.

Source

pub fn insert(&self, index: usize, obj: &ObjectType)

Insert an object into the array at the given index.

§Panics

Panics if the index is out of bounds.

Source

pub fn sort_by<F: FnMut(&ObjectType, &ObjectType) -> Ordering>( &self, compare: F, )

Available on crate feature NSObjCRuntime only.

Sort the array by the given comparison closure.

Source§

impl<ObjectType: Message> NSMutableArray<ObjectType>

Methods declared on superclass NSArray.

NSArrayCreation.

Source

pub unsafe fn array() -> Retained<Self>

Source

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

Source

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

Source

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

Source

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

Source

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

Source§

impl<ObjectType: Message> NSMutableArray<ObjectType>

Source

pub fn addObject(&self, an_object: &ObjectType)

Source

pub fn insertObject_atIndex(&self, an_object: &ObjectType, index: NSUInteger)

Source

pub fn removeLastObject(&self)

Source

pub fn removeObjectAtIndex(&self, index: NSUInteger)

Source

pub fn replaceObjectAtIndex_withObject( &self, index: NSUInteger, an_object: &ObjectType, )

Source

pub fn init(this: Allocated<Self>) -> Retained<Self>

Source

pub fn initWithCapacity( this: Allocated<Self>, num_items: NSUInteger, ) -> Retained<Self>

Source

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

Available on crate feature NSCoder only.
Source§

impl<ObjectType: Message> NSMutableArray<ObjectType>

Methods declared on superclass NSArray.

Source

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

Source§

impl<ObjectType: Message> NSMutableArray<ObjectType>

Methods declared on superclass NSObject.

Source

pub fn new() -> Retained<Self>

Source§

impl<ObjectType: Message> NSMutableArray<ObjectType>

NSExtendedMutableArray.

Source

pub unsafe fn addObjectsFromArray(&self, other_array: &NSArray<ObjectType>)

Source

pub unsafe fn exchangeObjectAtIndex_withObjectAtIndex( &self, idx1: NSUInteger, idx2: NSUInteger, )

Source

pub fn removeAllObjects(&self)

Source

pub unsafe fn removeObject_inRange( &self, an_object: &ObjectType, range: NSRange, )

Available on crate feature NSRange only.
Source

pub fn removeObject(&self, an_object: &ObjectType)

Source

pub unsafe fn removeObjectIdenticalTo_inRange( &self, an_object: &ObjectType, range: NSRange, )

Available on crate feature NSRange only.
Source

pub unsafe fn removeObjectIdenticalTo(&self, an_object: &ObjectType)

Source

pub unsafe fn removeObjectsFromIndices_numIndices( &self, indices: NonNull<NSUInteger>, cnt: NSUInteger, )

👎Deprecated: Not supported
Source

pub unsafe fn removeObjectsInArray(&self, other_array: &NSArray<ObjectType>)

Source

pub unsafe fn removeObjectsInRange(&self, range: NSRange)

Available on crate feature NSRange only.
Source

pub unsafe fn replaceObjectsInRange_withObjectsFromArray_range( &self, range: NSRange, other_array: &NSArray<ObjectType>, other_range: NSRange, )

Available on crate feature NSRange only.
Source

pub unsafe fn replaceObjectsInRange_withObjectsFromArray( &self, range: NSRange, other_array: &NSArray<ObjectType>, )

Available on crate feature NSRange only.
Source

pub unsafe fn setArray(&self, other_array: &NSArray<ObjectType>)

Source

pub unsafe fn sortUsingFunction_context( &self, compare: unsafe extern "C-unwind" fn(NonNull<ObjectType>, NonNull<ObjectType>, *mut c_void) -> NSInteger, context: *mut c_void, )

Source

pub unsafe fn sortUsingSelector(&self, comparator: Sel)

Source

pub unsafe fn insertObjects_atIndexes( &self, objects: &NSArray<ObjectType>, indexes: &NSIndexSet, )

Available on crate feature NSIndexSet only.
Source

pub unsafe fn removeObjectsAtIndexes(&self, indexes: &NSIndexSet)

Available on crate feature NSIndexSet only.
Source

pub unsafe fn replaceObjectsAtIndexes_withObjects( &self, indexes: &NSIndexSet, objects: &NSArray<ObjectType>, )

Available on crate feature NSIndexSet only.
Source

pub unsafe fn setObject_atIndexedSubscript( &self, obj: &ObjectType, idx: NSUInteger, )

Source

pub unsafe fn sortUsingComparator(&self, cmptr: NSComparator)

Available on crate features NSObjCRuntime and block2 only.
Source

pub unsafe fn sortWithOptions_usingComparator( &self, opts: NSSortOptions, cmptr: NSComparator, )

Available on crate features NSObjCRuntime and block2 only.
Source§

impl<ObjectType: Message> NSMutableArray<ObjectType>

NSMutableArrayCreation.

Source

pub unsafe fn arrayWithCapacity(num_items: NSUInteger) -> Retained<Self>

Source

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

Available on crate feature NSString only.
Source

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

Available on crate feature NSURL only.
Source

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

Available on crate feature NSString only.
Source

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

Available on crate feature NSURL only.
Source§

impl<ObjectType: Message> NSMutableArray<ObjectType>

NSMutableArrayDiffing.

Source

pub unsafe fn applyDifference( &self, difference: &NSOrderedCollectionDifference<ObjectType>, )

Available on crate feature NSOrderedCollectionDifference only.
Source§

impl<ObjectType: Message> NSMutableArray<ObjectType>

NSPredicateSupport.

Source

pub unsafe fn filterUsingPredicate(&self, predicate: &NSPredicate)

Available on crate feature NSPredicate only.
Source§

impl<ObjectType: Message> NSMutableArray<ObjectType>

NSSortDescriptorSorting.

Source

pub unsafe fn sortUsingDescriptors( &self, sort_descriptors: &NSArray<NSSortDescriptor>, )

Available on crate feature NSSortDescriptor only.

Methods from Deref<Target = NSArray<ObjectType>>§

Source

pub unsafe fn objectAtIndex_unchecked(&self, index: usize) -> &ObjectType

Get a direct reference to one of the array’s objects.

Throws an error if the object was not found.

Consider using the objectAtIndex method instead, unless you’re seeing performance issues from the retaining.

§Safety

The array must not be mutated while the reference is live.

Source

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

A direct reference to the array’s first object, if any.

Consider using the firstObject method instead, unless you’re seeing performance issues from the retaining.

§Safety

The array must not be mutated while the reference is live.

Source

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

A direct reference to the array’s last object, if any.

Consider using the lastObject method instead, unless you’re seeing performance issues from the retaining.

§Safety

The array must not be mutated while the reference is live.

Source

pub unsafe fn to_vec_unchecked(&self) -> Vec<&ObjectType>

A vector containing direct references to the array’s objects.

Consider using the to_vec method instead, unless you’re seeing performance issues from the retaining.

§Safety

The array must not be mutated while the returned references are alive.

Source

pub unsafe fn iter_unchecked(&self) -> IterUnchecked<'_, ObjectType>

Available on crate feature NSEnumerator only.

Iterate over the array without retaining the elements.

Consider using the iter method instead, unless you’re seeing performance issues from the retaining.

§Safety

The array must not be mutated for the lifetime of the iterator or for the lifetime of the elements the iterator returns.

Source

pub fn len(&self) -> usize

The amount of elements in the array.

Source

pub fn is_empty(&self) -> bool

Whether the array is empty or not.

Source

pub fn to_vec(&self) -> Vec<Retained<ObjectType>>

Convert the array to a Vec of the array’s objects.

Source

pub fn iter(&self) -> Iter<'_, ObjectType>

Available on crate feature NSEnumerator only.

Iterate over the array’s elements.

Source

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

Available on crate feature NSRange only.

Returns the objects within the given range.

§Panics

Panics if the range was out of bounds.

Source

pub fn count(&self) -> NSUInteger

Source

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

Source

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

Source

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

Source

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

Available on crate feature NSString only.
Source

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

Source

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

Available on crate feature NSString only.
Source

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

Available on crate feature NSString only.
Source

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

Available on crate feature NSString only.
Source

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

Source

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

Available on crate feature NSRange only.
Source

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

Source

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

Available on crate feature NSRange only.
Source

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

Source

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

Available on crate feature NSRange only.
Source

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

Source

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

Source

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

Source

pub unsafe fn objectEnumerator(&self) -> Retained<NSEnumerator<ObjectType>>

Available on crate feature NSEnumerator only.
Source

pub unsafe fn reverseObjectEnumerator( &self, ) -> Retained<NSEnumerator<ObjectType>>

Available on crate feature NSEnumerator only.
Source

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

Available on crate feature NSData only.
Source

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

Source

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

Available on crate feature NSData only.
Source

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

Source

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

Available on crate feature NSRange only.
Source

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

Available on crate features NSError and NSURL only.
Source

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

Source

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

Source

pub unsafe fn objectsAtIndexes( &self, indexes: &NSIndexSet, ) -> Retained<NSArray<ObjectType>>

Available on crate feature NSIndexSet only.
Source

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

Source

pub unsafe fn enumerateObjectsUsingBlock( &self, block: &DynBlock<dyn Fn(NonNull<ObjectType>, NSUInteger, NonNull<Bool>) + '_>, )

Available on crate feature block2 only.
Source

pub unsafe fn enumerateObjectsWithOptions_usingBlock( &self, opts: NSEnumerationOptions, block: &DynBlock<dyn Fn(NonNull<ObjectType>, NSUInteger, NonNull<Bool>) + '_>, )

Available on crate features NSObjCRuntime and block2 only.
Source

pub unsafe fn enumerateObjectsAtIndexes_options_usingBlock( &self, s: &NSIndexSet, opts: NSEnumerationOptions, block: &DynBlock<dyn Fn(NonNull<ObjectType>, NSUInteger, NonNull<Bool>) + '_>, )

Available on crate features NSIndexSet and NSObjCRuntime and block2 only.
Source

pub unsafe fn indexOfObjectPassingTest( &self, predicate: &DynBlock<dyn Fn(NonNull<ObjectType>, NSUInteger, NonNull<Bool>) -> Bool + '_>, ) -> NSUInteger

Available on crate feature block2 only.
Source

pub unsafe fn indexOfObjectWithOptions_passingTest( &self, opts: NSEnumerationOptions, predicate: &DynBlock<dyn Fn(NonNull<ObjectType>, NSUInteger, NonNull<Bool>) -> Bool + '_>, ) -> NSUInteger

Available on crate features NSObjCRuntime and block2 only.
Source

pub unsafe fn indexOfObjectAtIndexes_options_passingTest( &self, s: &NSIndexSet, opts: NSEnumerationOptions, predicate: &DynBlock<dyn Fn(NonNull<ObjectType>, NSUInteger, NonNull<Bool>) -> Bool + '_>, ) -> NSUInteger

Available on crate features NSIndexSet and NSObjCRuntime and block2 only.
Source

pub unsafe fn indexesOfObjectsPassingTest( &self, predicate: &DynBlock<dyn Fn(NonNull<ObjectType>, NSUInteger, NonNull<Bool>) -> Bool + '_>, ) -> Retained<NSIndexSet>

Available on crate features NSIndexSet and block2 only.
Source

pub unsafe fn indexesOfObjectsWithOptions_passingTest( &self, opts: NSEnumerationOptions, predicate: &DynBlock<dyn Fn(NonNull<ObjectType>, NSUInteger, NonNull<Bool>) -> Bool + '_>, ) -> Retained<NSIndexSet>

Available on crate features NSIndexSet and NSObjCRuntime and block2 only.
Source

pub unsafe fn indexesOfObjectsAtIndexes_options_passingTest( &self, s: &NSIndexSet, opts: NSEnumerationOptions, predicate: &DynBlock<dyn Fn(NonNull<ObjectType>, NSUInteger, NonNull<Bool>) -> Bool + '_>, ) -> Retained<NSIndexSet>

Available on crate features NSIndexSet and NSObjCRuntime and block2 only.
Source

pub unsafe fn sortedArrayUsingComparator( &self, cmptr: NSComparator, ) -> Retained<NSArray<ObjectType>>

Available on crate features NSObjCRuntime and block2 only.
Source

pub unsafe fn sortedArrayWithOptions_usingComparator( &self, opts: NSSortOptions, cmptr: NSComparator, ) -> Retained<NSArray<ObjectType>>

Available on crate features NSObjCRuntime and block2 only.
Source

pub unsafe fn indexOfObject_inSortedRange_options_usingComparator( &self, obj: &ObjectType, r: NSRange, opts: NSBinarySearchingOptions, cmp: NSComparator, ) -> NSUInteger

Available on crate features NSObjCRuntime and NSRange and block2 only.
Source

pub unsafe fn differenceFromArray_withOptions_usingEquivalenceTest( &self, other: &NSArray<ObjectType>, options: NSOrderedCollectionDifferenceCalculationOptions, block: &DynBlock<dyn Fn(NonNull<ObjectType>, NonNull<ObjectType>) -> Bool + '_>, ) -> Retained<NSOrderedCollectionDifference<ObjectType>>

Available on crate features NSOrderedCollectionDifference and block2 only.
Source

pub unsafe fn differenceFromArray_withOptions( &self, other: &NSArray<ObjectType>, options: NSOrderedCollectionDifferenceCalculationOptions, ) -> Retained<NSOrderedCollectionDifference<ObjectType>>

Available on crate feature NSOrderedCollectionDifference only.
Source

pub unsafe fn differenceFromArray( &self, other: &NSArray<ObjectType>, ) -> Retained<NSOrderedCollectionDifference<ObjectType>>

Available on crate feature NSOrderedCollectionDifference only.
Source

pub unsafe fn arrayByApplyingDifference( &self, difference: &NSOrderedCollectionDifference<ObjectType>, ) -> Option<Retained<NSArray<ObjectType>>>

Available on crate feature NSOrderedCollectionDifference only.
Source

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

👎Deprecated: Use -getObjects:range: instead
Source

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

👎Deprecated
Available on crate feature NSString only.
Source

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

👎Deprecated
Available on crate feature NSURL only.
Source

pub unsafe fn valueForKey(&self, key: &NSString) -> Retained<AnyObject>

Available on crate features NSKeyValueCoding and NSString only.
Source

pub unsafe fn setValue_forKey(&self, value: Option<&AnyObject>, key: &NSString)

Available on crate features NSKeyValueCoding and NSString only.
Source

pub unsafe fn addObserver_toObjectsAtIndexes_forKeyPath_options_context( &self, observer: &NSObject, indexes: &NSIndexSet, key_path: &NSString, options: NSKeyValueObservingOptions, context: *mut c_void, )

Available on crate features NSKeyValueObserving and NSIndexSet and NSString only.
Source

pub unsafe fn removeObserver_fromObjectsAtIndexes_forKeyPath_context( &self, observer: &NSObject, indexes: &NSIndexSet, key_path: &NSString, context: *mut c_void, )

Available on crate features NSKeyValueObserving and NSIndexSet and NSString only.
Source

pub unsafe fn removeObserver_fromObjectsAtIndexes_forKeyPath( &self, observer: &NSObject, indexes: &NSIndexSet, key_path: &NSString, )

Available on crate features NSKeyValueObserving and NSIndexSet and NSString only.
Source

pub unsafe fn addObserver_forKeyPath_options_context( &self, observer: &NSObject, key_path: &NSString, options: NSKeyValueObservingOptions, context: *mut c_void, )

Available on crate features NSKeyValueObserving and NSString only.
Source

pub unsafe fn removeObserver_forKeyPath_context( &self, observer: &NSObject, key_path: &NSString, context: *mut c_void, )

Available on crate features NSKeyValueObserving and NSString only.
Source

pub unsafe fn removeObserver_forKeyPath( &self, observer: &NSObject, key_path: &NSString, )

Available on crate features NSKeyValueObserving and NSString only.
Source

pub unsafe fn pathsMatchingExtensions( &self, filter_types: &NSArray<NSString>, ) -> Retained<NSArray<NSString>>

Available on crate features NSPathUtilities and NSString only.
Source

pub unsafe fn filteredArrayUsingPredicate( &self, predicate: &NSPredicate, ) -> Retained<NSArray<ObjectType>>

Available on crate feature NSPredicate only.
Source

pub unsafe fn sortedArrayUsingDescriptors( &self, sort_descriptors: &NSArray<NSSortDescriptor>, ) -> Retained<NSArray<ObjectType>>

Available on crate feature NSSortDescriptor only.

Methods from Deref<Target = NSObject>§

Source

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

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

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

Dynamically find the class of this object.

§Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

§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());
Source

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.

Source

pub fn downcast_ref<T>(&self) -> Option<&T>
where T: DowncastTarget,

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

§Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

§Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

§Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

§Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}

Trait Implementations§

Source§

impl<ObjectType: ?Sized + Message> AsRef<AnyObject> for NSMutableArray<ObjectType>

Source§

fn as_ref(&self) -> &AnyObject

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

impl<ObjectType: ?Sized + Message> AsRef<NSArray<ObjectType>> for NSMutableArray<ObjectType>

Source§

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

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

impl<ObjectType: ?Sized + Message> AsRef<NSMutableArray<ObjectType>> for NSMutableArray<ObjectType>

Source§

fn as_ref(&self) -> &Self

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

impl<ObjectType: ?Sized + Message> AsRef<NSObject> for NSMutableArray<ObjectType>

Source§

fn as_ref(&self) -> &NSObject

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

impl<ObjectType: ?Sized + Message> Borrow<AnyObject> for NSMutableArray<ObjectType>

Source§

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value. Read more
Source§

impl<ObjectType: ?Sized + Message> Borrow<NSArray<ObjectType>> for NSMutableArray<ObjectType>

Source§

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

Immutably borrows from an owned value. Read more
Source§

impl<ObjectType: ?Sized + Message> Borrow<NSObject> for NSMutableArray<ObjectType>

Source§

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value. Read more
Source§

impl<ObjectType: ?Sized + Message> ClassType for NSMutableArray<ObjectType>

Source§

const NAME: &'static str = "NSMutableArray"

The name of the Objective-C class that this type represents. Read more
Source§

type Super = NSArray<ObjectType>

The superclass of this class. Read more
Source§

type ThreadKind = <<NSMutableArray<ObjectType> as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread. Read more
Source§

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents. Read more
Source§

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

Get an immutable reference to the superclass.
Source§

impl<ObjectType: ?Sized + Message> CopyingHelper for NSMutableArray<ObjectType>

Available on crate feature NSObject only.
Source§

type Result = NSArray<ObjectType>

The immutable counterpart of the type, or Self if the type has no immutable counterpart. Read more
Source§

impl<ObjectType: Debug + Message> Debug for NSMutableArray<ObjectType>

Available on crate feature NSEnumerator only.
Source§

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

Formats the value using the given formatter. Read more
Source§

impl<ObjectType: Message> DefaultRetained for NSMutableArray<ObjectType>

Source§

fn default_retained() -> Retained<Self>

The default Retained for a type. Read more
Source§

impl<ObjectType: ?Sized + Message> Deref for NSMutableArray<ObjectType>

Source§

type Target = NSArray<ObjectType>

The resulting type after dereferencing.
Source§

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

Dereferences the value.
Source§

impl<'a, ObjectType: Message> Extend<&'a ObjectType> for &NSMutableArray<ObjectType>

Source§

fn extend<I: IntoIterator<Item = &'a ObjectType>>(&mut self, iter: I)

Extends a collection with the contents of an iterator. Read more
Source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
Source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
Source§

impl<ObjectType: Message> Extend<Retained<ObjectType>> for &NSMutableArray<ObjectType>

Source§

fn extend<I: IntoIterator<Item = Retained<ObjectType>>>(&mut self, iter: I)

Extends a collection with the contents of an iterator. Read more
Source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
Source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
Source§

impl<ObjectType: ?Sized> Hash for NSMutableArray<ObjectType>

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<'a, ObjectType: Message> IntoIterator for &'a NSMutableArray<ObjectType>

Source§

type Item = Retained<ObjectType>

The type of the elements being iterated over.
Source§

type IntoIter = Iter<'a, ObjectType>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl<ObjectType: ?Sized + Message> Message for NSMutableArray<ObjectType>

Source§

fn retain(&self) -> Retained<Self>
where Self: Sized,

Increment the reference count of the receiver. Read more
Source§

impl<ObjectType: ?Sized + Message> MutableCopyingHelper for NSMutableArray<ObjectType>

Available on crate feature NSObject only.
Source§

type Result = NSMutableArray<ObjectType>

The mutable counterpart of the type, or Self if the type has no mutable counterpart. Read more
Source§

impl<ObjectType: ?Sized + NSCoding> NSCoding for NSMutableArray<ObjectType>

Source§

unsafe fn encodeWithCoder(&self, coder: &NSCoder)
where Self: Sized + Message,

Available on crate features NSObject and NSCoder only.
Source§

unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder, ) -> Option<Retained<Self>>
where Self: Sized + Message,

Available on crate features NSObject and NSCoder only.
Source§

impl<ObjectType: ?Sized> NSCopying for NSMutableArray<ObjectType>

Source§

fn copy(&self) -> Retained<Self::Result>
where Self: Sized + Message + CopyingHelper,

Available on crate feature NSObject only.
Returns a new instance that’s a copy of the receiver. Read more
Source§

unsafe fn copyWithZone(&self, zone: *mut NSZone) -> Retained<Self::Result>
where Self: Sized + Message + CopyingHelper,

Available on crate feature NSObject only.
Returns a new instance that’s a copy of the receiver. Read more
Source§

impl<ObjectType: ?Sized> NSFastEnumeration for NSMutableArray<ObjectType>

Source§

unsafe fn countByEnumeratingWithState_objects_count( &self, state: NonNull<NSFastEnumerationState>, buffer: NonNull<*mut AnyObject>, len: NSUInteger, ) -> NSUInteger
where Self: Sized + Message,

Available on crate feature NSEnumerator only.
Source§

impl<ObjectType: ?Sized> NSMutableCopying for NSMutableArray<ObjectType>

Source§

fn mutableCopy(&self) -> Retained<Self::Result>

Available on crate feature NSObject only.
Returns a new instance that’s a mutable copy of the receiver. Read more
Source§

unsafe fn mutableCopyWithZone( &self, zone: *mut NSZone, ) -> Retained<Self::Result>

Available on crate feature NSObject only.
Returns a new instance that’s a mutable copy of the receiver. Read more
Source§

impl<ObjectType: ?Sized> NSObjectProtocol for NSMutableArray<ObjectType>

Source§

fn isEqual(&self, other: Option<&AnyObject>) -> bool
where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object. Read more
Source§

fn hash(&self) -> usize
where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure. Read more
Source§

fn isKindOfClass(&self, cls: &AnyClass) -> bool
where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses. Read more
Source§

fn is_kind_of<T>(&self) -> bool
where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref
Check if the object is an instance of the class type, or one of its subclasses. Read more
Source§

fn isMemberOfClass(&self, cls: &AnyClass) -> bool
where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses. Read more
Source§

fn respondsToSelector(&self, aSelector: Sel) -> bool
where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector. Read more
Source§

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool
where Self: Sized + Message,

Check whether the object conforms to a given protocol. Read more
Source§

fn description(&self) -> Retained<NSObject>
where Self: Sized + Message,

A textual representation of the object. Read more
Source§

fn debugDescription(&self) -> Retained<NSObject>
where Self: Sized + Message,

A textual representation of the object to use when debugging. Read more
Source§

fn isProxy(&self) -> bool
where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject. Read more
Source§

fn retainCount(&self) -> usize
where Self: Sized + Message,

The reference count of the object. Read more
Source§

impl<ObjectType: ?Sized + NSSecureCoding> NSSecureCoding for NSMutableArray<ObjectType>

Source§

unsafe fn supportsSecureCoding() -> bool
where Self: Sized + ClassType,

Available on crate feature NSObject only.
Source§

impl<ObjectType: ?Sized> PartialEq for NSMutableArray<ObjectType>

Source§

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl<ObjectType: ?Sized + Message> RefEncode for NSMutableArray<ObjectType>

Source§

const ENCODING_REF: Encoding = <NSArray<ObjectType> as ::objc2::RefEncode>::ENCODING_REF

The Objective-C type-encoding for a reference of this type. Read more
Source§

impl<'a, ObjectType: Message + 'a> RetainedFromIterator<&'a ObjectType> for NSMutableArray<ObjectType>

Source§

fn retained_from_iter<I: IntoIterator<Item = &'a ObjectType>>( iter: I, ) -> Retained<Self>

Creates an Retained from an iterator.
Source§

impl<ObjectType: Message> RetainedFromIterator<Retained<ObjectType>> for NSMutableArray<ObjectType>

Source§

fn retained_from_iter<I: IntoIterator<Item = Retained<ObjectType>>>( iter: I, ) -> Retained<Self>

Creates an Retained from an iterator.
Source§

impl<ObjectType: Message> RetainedIntoIterator for NSMutableArray<ObjectType>

Source§

type Item = Retained<ObjectType>

The type of the elements being iterated over.
Source§

type IntoIter = IntoIter<ObjectType>

Which kind of iterator are we turning this into?
Source§

fn retained_into_iter(this: Retained<Self>) -> Self::IntoIter

Creates an iterator from an Retained. Read more
Source§

impl<ObjectType: Message> ToOwned for NSMutableArray<ObjectType>

Available on crate feature NSObject only.
Source§

type Owned = Retained<NSMutableArray<ObjectType>>

The resulting type after obtaining ownership.
Source§

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

Creates owned data from borrowed data, usually by cloning. Read more
1.63.0 · Source§

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

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl DowncastTarget for NSMutableArray<AnyObject>

Source§

impl<ObjectType: ?Sized> Eq for NSMutableArray<ObjectType>

Auto Trait Implementations§

§

impl<ObjectType = AnyObject> !Freeze for NSMutableArray<ObjectType>

§

impl<ObjectType = AnyObject> !RefUnwindSafe for NSMutableArray<ObjectType>

§

impl<ObjectType = AnyObject> !Send for NSMutableArray<ObjectType>

§

impl<ObjectType = AnyObject> !Sync for NSMutableArray<ObjectType>

§

impl<ObjectType = AnyObject> !Unpin for NSMutableArray<ObjectType>

§

impl<ObjectType = AnyObject> !UnwindSafe for NSMutableArray<ObjectType>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<'a, T> AnyThread for T
where T: ClassType<ThreadKind = dyn AnyThread + 'a> + ?Sized,

Source§

fn alloc() -> Allocated<Self>
where Self: Sized + ClassType,

Allocate a new instance of the class. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> AutoreleaseSafe for T
where T: ?Sized,