Struct objc2::foundation::NSMutableDictionary
source · [−]foundation
only.Expand description
A mutable collection of objects associated with unique keys.
See the documentation for NSDictionary
and/or Apple’s
documentation for more information.
Implementations
sourceimpl<K: Message, V: Message> NSMutableDictionary<K, V>
impl<K: Message, V: Message> NSMutableDictionary<K, V>
sourcepub 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 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;
Creates an empty NSMutableDictionary
.
Examples
use objc2::foundation::{NSMutableDictionary, NSObject, NSString};
let dict = NSMutableDictionary::<NSString, NSObject>::new();
sourcepub fn from_keys_and_objects<T>(
keys: &[&T],
vals: Vec<Id<V, Owned>>
) -> 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;
where
T: NSCopying<Output = K>,
pub fn from_keys_and_objects<T>(
keys: &[&T],
vals: Vec<Id<V, Owned>>
) -> 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;
where
T: NSCopying<Output = K>,
Creates an NSMutableDictionary
from a slice of keys and a
vector of values.
Examples
use objc2::foundation::{NSMutableDictionary, NSNumber, NSObject};
let dict = NSMutableDictionary::from_keys_and_objects(
&[
&*NSNumber::new_i32(1),
&*NSNumber::new_i32(2),
&*NSNumber::new_i32(3),
],
vec![NSObject::new(), NSObject::new(), NSObject::new()],
);
sourcepub fn get_mut(&mut self, key: &K) -> Option<&mut V>
pub fn get_mut(&mut self, key: &K) -> Option<&mut V>
Returns a mutable reference to the value corresponding to the key.
Examples
use objc2::foundation::{NSMutableDictionary, NSObject, NSString};
use objc2::ns_string;
let mut dict = NSMutableDictionary::new();
dict.insert(NSString::from_str("one"), NSObject::new());
println!("{:?}", dict.get_mut(ns_string!("one")));
sourcepub fn values_mut(&mut self) -> Vec<&mut V>
pub fn values_mut(&mut self) -> Vec<&mut V>
Returns a vector of mutable references to the values in the dictionary.
Examples
use objc2::foundation::{NSMutableDictionary, NSObject, NSString};
let mut dict = NSMutableDictionary::new();
dict.insert(NSString::from_str("one"), NSObject::new());
for val in dict.values_mut() {
println!("{:?}", val);
}
sourcepub fn insert(
&mut self,
key: Id<K, Shared>,
value: Id<V, Owned>
) -> Option<Id<V, Owned>>
pub fn insert(
&mut self,
key: Id<K, Shared>,
value: Id<V, Owned>
) -> Option<Id<V, Owned>>
Inserts a key-value pair into the dictionary.
If the dictionary did not have this key present, None is returned. If the dictionary did have this key present, the value is updated, and the old value is returned.
Examples
use objc2::foundation::{NSMutableDictionary, NSObject, NSString};
let mut dict = NSMutableDictionary::new();
dict.insert(NSString::from_str("one"), NSObject::new());
sourcepub fn remove(&mut self, key: &K) -> Option<Id<V, Owned>>
pub fn remove(&mut self, key: &K) -> Option<Id<V, Owned>>
Removes a key from the dictionary, returning the value at the key if the key was previously in the dictionary.
Examples
use objc2::foundation::{NSMutableDictionary, NSObject, NSString};
use objc2::ns_string;
let mut dict = NSMutableDictionary::new();
dict.insert(NSString::from_str("one"), NSObject::new());
dict.remove(ns_string!("one"));
assert!(dict.is_empty());
sourcepub fn clear(&mut self)
pub fn clear(&mut self)
Clears the dictionary, removing all key-value pairs.
Examples
use objc2::foundation::{NSMutableDictionary, NSObject, NSString};
let mut dict = NSMutableDictionary::new();
dict.insert(NSString::from_str("one"), NSObject::new());
dict.clear();
assert!(dict.is_empty());
sourcepub fn into_values_array(dict: Id<Self, Owned>) -> Id<NSArray<V, Owned>, 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;
pub fn into_values_array(dict: Id<Self, Owned>) -> Id<NSArray<V, Owned>, 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;
Returns an NSArray
containing the dictionary’s values,
consuming the dictionary.
Examples
use objc2::foundation::{NSMutableDictionary, NSObject, NSString};
let mut dict = NSMutableDictionary::new();
dict.insert(NSString::from_str("one"), NSObject::new());
let array = NSMutableDictionary::into_values_array(dict);
println!("{:?}", array);
Methods from Deref<Target = NSDictionary<K, V>>
pub fn len(&self) -> usize
pub fn is_empty(&self) -> bool
pub fn get(&self, key: &K) -> Option<&V>
pub fn keys(&self) -> Vec<&K>
pub fn values(&self) -> Vec<&V>
pub fn keys_and_objects(&self) -> (Vec<&K>, Vec<&V>)
pub fn iter_keys(&self) -> NSEnumerator<'_, K>ⓘNotable traits for NSEnumerator<'a, T>impl<'a, T: Message> Iterator for NSEnumerator<'a, T> type Item = &'a T;
pub fn iter_values(&self) -> NSEnumerator<'_, V>ⓘNotable traits for NSEnumerator<'a, T>impl<'a, T: Message> Iterator for NSEnumerator<'a, T> type Item = &'a T;
pub fn keys_array(&self) -> Id<NSArray<K, Shared>, 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<K: Message, V: Message> AsMut<NSDictionary<K, V>> for NSMutableDictionary<K, V>
impl<K: Message, V: Message> AsMut<NSDictionary<K, V>> for NSMutableDictionary<K, V>
sourcefn as_mut(&mut self) -> &mut NSDictionary<K, V>
fn as_mut(&mut self) -> &mut NSDictionary<K, V>
Converts this type into a mutable reference of the (usually inferred) input type.
sourceimpl<K: Message, V: Message> AsMut<NSMutableDictionary<K, V>> for NSMutableDictionary<K, V>
impl<K: Message, V: Message> AsMut<NSMutableDictionary<K, V>> for NSMutableDictionary<K, V>
sourceimpl<K: Message, V: Message> AsRef<NSDictionary<K, V>> for NSMutableDictionary<K, V>
impl<K: Message, V: Message> AsRef<NSDictionary<K, V>> for NSMutableDictionary<K, V>
sourcefn as_ref(&self) -> &NSDictionary<K, V>
fn as_ref(&self) -> &NSDictionary<K, V>
Converts this type into a shared reference of the (usually inferred) input type.
sourceimpl<K: Message, V: Message> AsRef<NSMutableDictionary<K, V>> for NSMutableDictionary<K, V>
impl<K: Message, V: Message> AsRef<NSMutableDictionary<K, V>> for NSMutableDictionary<K, V>
sourceimpl<K: Message, V: Message> Borrow<NSDictionary<K, V>> for NSMutableDictionary<K, V>
impl<K: Message, V: Message> Borrow<NSDictionary<K, V>> for NSMutableDictionary<K, V>
sourcefn borrow(&self) -> &NSDictionary<K, V>
fn borrow(&self) -> &NSDictionary<K, V>
Immutably borrows from an owned value. Read more
sourceimpl<K: Message, V: Message> BorrowMut<NSDictionary<K, V>> for NSMutableDictionary<K, V>
impl<K: Message, V: Message> BorrowMut<NSDictionary<K, V>> for NSMutableDictionary<K, V>
sourcefn borrow_mut(&mut self) -> &mut NSDictionary<K, V>
fn borrow_mut(&mut self) -> &mut NSDictionary<K, V>
Mutably borrows from an owned value. Read more
sourceimpl<K: Message, V: Message> BorrowMut<NSObject> for NSMutableDictionary<K, V>
impl<K: Message, V: Message> BorrowMut<NSObject> for NSMutableDictionary<K, V>
sourcefn borrow_mut(&mut self) -> &mut NSObject
fn borrow_mut(&mut self) -> &mut NSObject
Mutably borrows from an owned value. Read more
sourceimpl<K: Message, V: Message> BorrowMut<Object> for NSMutableDictionary<K, V>
impl<K: Message, V: Message> BorrowMut<Object> for NSMutableDictionary<K, V>
sourcefn borrow_mut(&mut self) -> &mut Object
fn borrow_mut(&mut self) -> &mut Object
Mutably borrows from an owned value. Read more
sourceimpl<K: Message, V: Message> ClassType for NSMutableDictionary<K, V>
impl<K: Message, V: Message> ClassType for NSMutableDictionary<K, V>
type Super = NSDictionary<K, V>
type Super = NSDictionary<K, V>
The superclass of this class. Read more
sourcefn class() -> &'static Class
fn class() -> &'static Class
Get a reference to the Objective-C class that this type represents. Read more
sourcefn as_super_mut(&mut self) -> &mut Self::Super
fn as_super_mut(&mut self) -> &mut Self::Super
Get a mutable reference to the superclass.
sourceimpl<K: Message, V: Message> DefaultId for NSMutableDictionary<K, V>
impl<K: Message, V: Message> DefaultId for NSMutableDictionary<K, V>
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<K: Message, V: Message> Deref for NSMutableDictionary<K, V>
impl<K: Message, V: Message> Deref for NSMutableDictionary<K, V>
type Target = NSDictionary<K, V>
type Target = NSDictionary<K, V>
The resulting type after dereferencing.
sourceimpl<K: Message, V: Message> DerefMut for NSMutableDictionary<K, V>
impl<K: Message, V: Message> DerefMut for NSMutableDictionary<K, V>
sourceimpl<K: Message, V: Message> NSFastEnumeration for NSMutableDictionary<K, V>
impl<K: Message, V: Message> NSFastEnumeration for NSMutableDictionary<K, V>
type Item = K
type Item = K
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.sourceimpl<K: PartialEq + Message, V: PartialEq + Message> PartialEq<NSMutableDictionary<K, V>> for NSMutableDictionary<K, V>
impl<K: PartialEq + Message, V: PartialEq + Message> PartialEq<NSMutableDictionary<K, V>> for NSMutableDictionary<K, V>
sourcefn eq(&self, other: &NSMutableDictionary<K, V>) -> bool
fn eq(&self, other: &NSMutableDictionary<K, V>) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourceimpl<K: Message, V: Message> RefEncode for NSMutableDictionary<K, V>
impl<K: Message, V: Message> RefEncode for NSMutableDictionary<K, V>
sourceconst ENCODING_REF: Encoding = <NSDictionary<K, V> as crate::RefEncode>::ENCODING_REF
const ENCODING_REF: Encoding = <NSDictionary<K, V> as crate::RefEncode>::ENCODING_REF
The Objective-C type-encoding for a reference of this type. Read more
impl<K: Eq + Message, V: Eq + Message> Eq for NSMutableDictionary<K, V>
impl<K: Message, V: Message> Message for NSMutableDictionary<K, V>
impl<K: Message + RefUnwindSafe, V: Message + RefUnwindSafe> RefUnwindSafe for NSMutableDictionary<K, V>
impl<K: Message + Sync + Send, V: Message + Send> Send for NSMutableDictionary<K, V>
impl<K: Message, V: Message> StructuralEq for NSMutableDictionary<K, V>
impl<K: Message, V: Message> StructuralPartialEq for NSMutableDictionary<K, V>
impl<K: Message + Sync + Send, V: Message + Sync> Sync for NSMutableDictionary<K, V>
impl<K: Message + UnwindSafe, V: Message + UnwindSafe> UnwindSafe for NSMutableDictionary<K, V>
Auto Trait Implementations
impl<K, V> !Unpin for NSMutableDictionary<K, V>
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