Struct objc2::foundation::NSMutableArray
source · [−]foundation
only.Expand description
A growable ordered collection of objects.
See the documentation for NSArray
and/or Apple’s
documentation for more information.
Implementations
sourceimpl<T: Message, O: Ownership> NSMutableArray<T, O>
impl<T: Message, O: Ownership> NSMutableArray<T, O>
Generic creation methods.
pub fn new() -> Id<Self, Owned>ⓘNotable traits for Id<I, Owned>impl<I: Iterator + ?Sized> Iterator for Id<I, Owned> type Item = I::Item;impl<T: Read + ?Sized> Read for Id<T, Owned>impl<T: Write + ?Sized> Write for Id<T, Owned>impl<T: Future + Unpin + ?Sized> Future for Id<T, Owned> type Output = T::Output;
pub fn from_vec(vec: Vec<Id<T, O>>) -> Id<Self, Owned>ⓘNotable traits for Id<I, Owned>impl<I: Iterator + ?Sized> Iterator for Id<I, Owned> type Item = I::Item;impl<T: Read + ?Sized> Read for Id<T, Owned>impl<T: Write + ?Sized> Write for Id<T, Owned>impl<T: Future + Unpin + ?Sized> Future for Id<T, Owned> type Output = T::Output;
Creation methods that produce shared arrays.
pub fn from_slice(slice: &[Id<T, Shared>]) -> Id<Self, Owned>ⓘNotable traits for Id<I, Owned>impl<I: Iterator + ?Sized> Iterator for Id<I, Owned> type Item = I::Item;impl<T: Read + ?Sized> Read for Id<T, Owned>impl<T: Write + ?Sized> Write for Id<T, Owned>impl<T: Future + Unpin + ?Sized> Future for Id<T, Owned> type Output = T::Output;
sourceimpl<T: Message, O: Ownership> NSMutableArray<T, O>
impl<T: Message, O: Ownership> NSMutableArray<T, O>
Generic accessor methods.
pub fn push(&mut self, obj: Id<T, O>)
pub fn insert(&mut self, index: usize, obj: Id<T, O>)
pub fn replace(&mut self, index: usize, obj: Id<T, O>) -> Id<T, O>ⓘNotable traits for Id<I, Owned>impl<I: Iterator + ?Sized> Iterator for Id<I, Owned> type Item = I::Item;impl<T: Read + ?Sized> Read for Id<T, Owned>impl<T: Write + ?Sized> Write for Id<T, Owned>impl<T: Future + Unpin + ?Sized> Future for Id<T, Owned> type Output = T::Output;
pub fn remove(&mut self, index: usize) -> Id<T, O>ⓘNotable traits for Id<I, Owned>impl<I: Iterator + ?Sized> Iterator for Id<I, Owned> type Item = I::Item;impl<T: Read + ?Sized> Read for Id<T, Owned>impl<T: Write + ?Sized> Write for Id<T, Owned>impl<T: Future + Unpin + ?Sized> Future for Id<T, Owned> type Output = T::Output;
pub fn pop(&mut self) -> Option<Id<T, O>>
pub fn clear(&mut self)
pub fn sort_by<F: FnMut(&T, &T) -> Ordering>(&mut self, compare: F)
Methods from Deref<Target = NSArray<T, O>>
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>ⓘNotable traits for NSEnumerator<'a, T>impl<'a, T: Message> Iterator for NSEnumerator<'a, T> type Item = &'a T;
pub fn objects_in_range(&self, range: Range<usize>) -> Vec<&T>
pub fn to_vec(&self) -> Vec<&T>
pub fn get_retained(&self, index: usize) -> Id<T, Shared>ⓘNotable traits for Id<I, Owned>impl<I: Iterator + ?Sized> Iterator for Id<I, Owned> type Item = I::Item;impl<T: Read + ?Sized> Read for Id<T, Owned>impl<T: Write + ?Sized> Write for Id<T, Owned>impl<T: Future + Unpin + ?Sized> Future for Id<T, Owned> type Output = T::Output;
Methods from Deref<Target = NSObject>
sourcepub fn is_kind_of<T: ClassType>(&self) -> bool
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>
sourcepub unsafe fn ivar_ptr<T: Encode>(&self, name: &str) -> *mut T
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.
sourcepub unsafe fn ivar<T: Encode>(&self, name: &str) -> &T
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
).
sourcepub unsafe fn get_ivar<T: Encode>(&self, name: &str) -> &T
👎Deprecated: Use Object::ivar
instead.
pub unsafe fn get_ivar<T: Encode>(&self, name: &str) -> &T
Use Object::ivar
instead.
sourcepub unsafe fn ivar_mut<T: Encode>(&mut self, name: &str) -> &mut T
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.
sourcepub unsafe fn get_mut_ivar<T: Encode>(&mut self, name: &str) -> &mut T
👎Deprecated: Use Object::ivar_mut
instead.
pub unsafe fn get_mut_ivar<T: Encode>(&mut self, name: &str) -> &mut T
Use Object::ivar_mut
instead.
sourcepub unsafe fn set_ivar<T: Encode>(&mut self, name: &str, value: T)
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
sourceimpl<T: Message, O: Ownership> AsMut<NSMutableArray<T, O>> for NSMutableArray<T, O>
impl<T: Message, O: Ownership> AsMut<NSMutableArray<T, O>> for NSMutableArray<T, O>
sourceimpl<T: Message, O: Ownership> AsRef<NSMutableArray<T, O>> for NSMutableArray<T, O>
impl<T: Message, O: Ownership> AsRef<NSMutableArray<T, O>> for NSMutableArray<T, O>
sourceimpl<T: Message, O: Ownership> BorrowMut<NSArray<T, O>> for NSMutableArray<T, O>
impl<T: Message, O: Ownership> BorrowMut<NSArray<T, O>> for NSMutableArray<T, O>
sourcefn borrow_mut(&mut self) -> &mut NSArray<T, O>
fn borrow_mut(&mut self) -> &mut NSArray<T, O>
Mutably borrows from an owned value. Read more
sourceimpl<T: Message, O: Ownership> BorrowMut<NSObject> for NSMutableArray<T, O>
impl<T: Message, O: Ownership> BorrowMut<NSObject> for NSMutableArray<T, O>
sourcefn borrow_mut(&mut self) -> &mut NSObject
fn borrow_mut(&mut self) -> &mut NSObject
Mutably borrows from an owned value. Read more
sourceimpl<T: Message, O: Ownership> BorrowMut<Object> for NSMutableArray<T, O>
impl<T: Message, O: Ownership> BorrowMut<Object> for NSMutableArray<T, O>
sourcefn borrow_mut(&mut self) -> &mut Object
fn borrow_mut(&mut self) -> &mut Object
Mutably borrows from an owned value. Read more
sourceimpl<T: Message, O: Ownership> ClassType for NSMutableArray<T, O>
impl<T: Message, O: Ownership> ClassType for NSMutableArray<T, O>
sourceimpl<T: Message, O: Ownership> DefaultId for NSMutableArray<T, O>
impl<T: Message, O: Ownership> DefaultId for NSMutableArray<T, O>
sourcefn default_id() -> Id<Self, Self::Ownership>ⓘNotable traits for Id<I, Owned>impl<I: Iterator + ?Sized> Iterator for Id<I, Owned> type Item = I::Item;impl<T: Read + ?Sized> Read for Id<T, Owned>impl<T: Write + ?Sized> Write for Id<T, Owned>impl<T: Future + Unpin + ?Sized> Future for Id<T, Owned> type Output = T::Output;
fn default_id() -> Id<Self, Self::Ownership>ⓘNotable traits for Id<I, Owned>impl<I: Iterator + ?Sized> Iterator for Id<I, Owned> type Item = I::Item;impl<T: Read + ?Sized> Read for Id<T, Owned>impl<T: Write + ?Sized> Write for Id<T, Owned>impl<T: Future + Unpin + ?Sized> Future for Id<T, Owned> type Output = T::Output;
sourceimpl<T: Message, O: Ownership> Deref for NSMutableArray<T, O>
impl<T: Message, O: Ownership> Deref for NSMutableArray<T, O>
sourceimpl<T: Message, O: Ownership> DerefMut for NSMutableArray<T, O>
impl<T: Message, O: Ownership> DerefMut for NSMutableArray<T, O>
sourceimpl<T: Message, O: Ownership> Extend<Id<T, O>> for NSMutableArray<T, O>
impl<T: Message, O: Ownership> Extend<Id<T, O>> for NSMutableArray<T, O>
sourcefn extend<I: IntoIterator<Item = Id<T, O>>>(&mut self, iter: I)
fn extend<I: IntoIterator<Item = Id<T, O>>>(&mut self, iter: I)
Extends a collection with the contents of an iterator. Read more
sourcefn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)Extends a collection with exactly one element.
sourcefn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
sourceimpl<'a, T: Message, O: Ownership> IntoIterator for &'a NSMutableArray<T, O>
impl<'a, T: Message, O: Ownership> IntoIterator for &'a NSMutableArray<T, O>
type IntoIter = NSFastEnumerator<'a, NSMutableArray<T, O>>
type IntoIter = NSFastEnumerator<'a, NSMutableArray<T, O>>
Which kind of iterator are we turning this into?
This is implemented as a shallow copy.
type Ownership = Shared
type Ownership = Shared
foundation
only.Indicates whether the type is mutable or immutable. Read more
type Output = NSArray<T, Shared>
type Output = NSArray<T, Shared>
foundation
only.The output type. Read more
sourcefn copy(&self) -> Id<Self::Output, Self::Ownership>ⓘNotable traits for Id<I, Owned>impl<I: Iterator + ?Sized> Iterator for Id<I, Owned> type Item = I::Item;impl<T: Read + ?Sized> Read for Id<T, Owned>impl<T: Write + ?Sized> Write for Id<T, Owned>impl<T: Future + Unpin + ?Sized> Future for Id<T, Owned> type Output = T::Output;
fn copy(&self) -> Id<Self::Output, Self::Ownership>ⓘNotable traits for Id<I, Owned>impl<I: Iterator + ?Sized> Iterator for Id<I, Owned> type Item = I::Item;impl<T: Read + ?Sized> Read for Id<T, Owned>impl<T: Write + ?Sized> Write for Id<T, Owned>impl<T: Future + Unpin + ?Sized> Future for Id<T, Owned> type Output = T::Output;
foundation
only.sourceimpl<T: Message, O: Ownership> NSFastEnumeration for NSMutableArray<T, O>
impl<T: Message, O: Ownership> NSFastEnumeration for NSMutableArray<T, O>
type Item = T
type Item = T
foundation
only.sourcefn iter_fast(&self) -> NSFastEnumerator<'_, Self>ⓘNotable traits for NSFastEnumerator<'a, C>impl<'a, C: NSFastEnumeration + ?Sized> Iterator for NSFastEnumerator<'a, C> type Item = &'a C::Item;
fn iter_fast(&self) -> NSFastEnumerator<'_, Self>ⓘNotable traits for NSFastEnumerator<'a, C>impl<'a, C: NSFastEnumeration + ?Sized> Iterator for NSFastEnumerator<'a, C> type Item = &'a C::Item;
foundation
only.This is implemented as a shallow copy.
sourcefn mutable_copy(&self) -> Id<Self::Output, Owned>ⓘNotable traits for Id<I, Owned>impl<I: Iterator + ?Sized> Iterator for Id<I, Owned> type Item = I::Item;impl<T: Read + ?Sized> Read for Id<T, Owned>impl<T: Write + ?Sized> Write for Id<T, Owned>impl<T: Future + Unpin + ?Sized> Future for Id<T, Owned> type Output = T::Output;
fn mutable_copy(&self) -> Id<Self::Output, Owned>ⓘNotable traits for Id<I, Owned>impl<I: Iterator + ?Sized> Iterator for Id<I, Owned> type Item = I::Item;impl<T: Read + ?Sized> Read for Id<T, Owned>impl<T: Write + ?Sized> Write for Id<T, Owned>impl<T: Future + Unpin + ?Sized> Future for Id<T, Owned> type Output = T::Output;
foundation
only.sourceimpl<T: PartialEq + Message, O: PartialEq + Ownership> PartialEq<NSMutableArray<T, O>> for NSMutableArray<T, O>
impl<T: PartialEq + Message, O: PartialEq + Ownership> PartialEq<NSMutableArray<T, O>> for NSMutableArray<T, O>
sourcefn eq(&self, other: &NSMutableArray<T, O>) -> bool
fn eq(&self, other: &NSMutableArray<T, O>) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourceimpl<T: Message, O: Ownership> RefEncode for NSMutableArray<T, O>
impl<T: Message, O: Ownership> RefEncode for NSMutableArray<T, O>
sourceconst ENCODING_REF: Encoding = <NSArray<T, O> as crate::RefEncode>::ENCODING_REF
const ENCODING_REF: Encoding = <NSArray<T, O> as crate::RefEncode>::ENCODING_REF
The Objective-C type-encoding for a reference of this type. Read more
type Owned = Id<NSMutableArray<T, Shared>, Owned>
type Owned = Id<NSMutableArray<T, Shared>, Owned>
The resulting type after obtaining ownership.
sourcefn to_owned(&self) -> Self::Owned
fn to_owned(&self) -> Self::Owned
Creates owned data from borrowed data, usually by cloning. Read more
1.63.0 · sourcefn clone_into(&self, target: &mut Self::Owned)
fn clone_into(&self, target: &mut Self::Owned)
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<T: Eq + Message, O: Eq + Ownership> Eq for NSMutableArray<T, O>
impl<T: Message, O: Ownership> Message for NSMutableArray<T, O>
impl<T: Message + Send> Send for NSMutableArray<T, Owned>
impl<T: Message, O: Ownership> StructuralEq for NSMutableArray<T, O>
impl<T: Message, O: Ownership> StructuralPartialEq for NSMutableArray<T, O>
impl<T: Message + Sync> Sync for NSMutableArray<T, Owned>
Auto Trait Implementations
impl<T, O> RefUnwindSafe for NSMutableArray<T, O> where
T: RefUnwindSafe,
impl<T, O = Owned> !Send for NSMutableArray<T, O>
impl<T, O = Owned> !Sync for NSMutableArray<T, O>
impl<T, O = Owned> !Unpin for NSMutableArray<T, O>
impl<T, O = Owned> !UnwindSafe for NSMutableArray<T, O>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more