Struct objc2::foundation::NSMutableDictionary

#[repr(C)]
pub struct NSMutableDictionary<K: Message, V: Message> { /* private fields */ }

A mutable collection of objects associated with unique keys.

See the documentation for NSDictionary and/or Apple’s documentation for more information.

Implementations

impl<K: Message, V: Message> NSMutableDictionary<K, V>

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

Creates an empty NSMutableDictionary.

Examples

use objc2::foundation::{NSMutableDictionary, NSObject, NSString};

let dict = NSMutableDictionary::<NSString, NSObject>::new();

pub fn from_keys_and_objects<T>( keys: &[&T], vals: Vec<Id<V, Owned>> ) -> Id<Self, Owned> 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()],
);

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")));

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);
}

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

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

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

pub fn into_values_array(dict: Id<Self, Owned>) -> Id<NSArray<V, Owned>, Shared>

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>

pub fn iter_values(&self) -> NSEnumerator<'_, V>

pub fn keys_array(&self) -> Id<NSArray<K, Shared>, Shared>

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<K: Message, V: Message> AsMut<NSDictionary<K, V>> for NSMutableDictionary<K, V>

fn as_mut(&mut self) -> &mut NSDictionary<K, V>

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

impl<K: Message, V: Message> AsMut<NSMutableDictionary<K, V>> for NSMutableDictionary<K, V>

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

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

impl<K: Message, V: Message> AsMut<NSObject> for NSMutableDictionary<K, V>

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

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

impl<K: Message, V: Message> AsMut<Object> for NSMutableDictionary<K, V>

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

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

impl<K: Message, V: Message> AsRef<NSDictionary<K, V>> for NSMutableDictionary<K, V>

fn as_ref(&self) -> &NSDictionary<K, V>

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

impl<K: Message, V: Message> AsRef<NSMutableDictionary<K, V>> for NSMutableDictionary<K, V>

fn as_ref(&self) -> &Self

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

impl<K: Message, V: Message> AsRef<NSObject> for NSMutableDictionary<K, V>

fn as_ref(&self) -> &NSObject

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

impl<K: Message, V: Message> AsRef<Object> for NSMutableDictionary<K, V>

fn as_ref(&self) -> &Object

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

impl<K: Message, V: Message> Borrow<NSDictionary<K, V>> for NSMutableDictionary<K, V>

fn borrow(&self) -> &NSDictionary<K, V>

Immutably borrows from an owned value.

impl<K: Message, V: Message> Borrow<NSObject> for NSMutableDictionary<K, V>

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl<K: Message, V: Message> Borrow<Object> for NSMutableDictionary<K, V>

fn borrow(&self) -> &Object

Immutably borrows from an owned value.

impl<K: Message, V: Message> BorrowMut<NSDictionary<K, V>> for NSMutableDictionary<K, V>

fn borrow_mut(&mut self) -> &mut NSDictionary<K, V>

Mutably borrows from an owned value.

impl<K: Message, V: Message> BorrowMut<NSObject> for NSMutableDictionary<K, V>

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

Mutably borrows from an owned value.

impl<K: Message, V: Message> BorrowMut<Object> for NSMutableDictionary<K, V>

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

Mutably borrows from an owned value.

impl<K: Message, V: Message> ClassType for NSMutableDictionary<K, V>

type Super = NSDictionary<K, V>

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<K: Debug + Message, V: Debug + Message> Debug for NSMutableDictionary<K, V>

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

Formats the value using the given formatter.

impl<K: Message, V: Message> DefaultId for NSMutableDictionary<K, V>

type Ownership = Owned

Indicates whether the default value is mutable or immutable.

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

The default Id for a type.

impl<K: Message, V: Message> Deref for NSMutableDictionary<K, V>

type Target = NSDictionary<K, V>

The resulting type after dereferencing.

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

Dereferences the value.

impl<K: Message, V: Message> DerefMut for NSMutableDictionary<K, V>

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

Mutably dereferences the value.

impl<K: Hash + Message, V: Hash + Message> Hash for NSMutableDictionary<K, V>

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<'a, K: Message, V: Message> Index<&'a K> for NSMutableDictionary<K, V>

type Output = V

The returned type after indexing.

fn index<'s>(&'s self, index: &'a K) -> &'s V

Performs the indexing (container[index]) operation.

impl<'a, K: Message, V: Message> IndexMut<&'a K> for NSMutableDictionary<K, V>

fn index_mut<'s>(&'s mut self, index: &'a K) -> &'s mut V

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

impl<K: Message, V: Message> NSFastEnumeration for NSMutableDictionary<K, V>

type Item = K

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

impl<K: PartialEq + Message, V: PartialEq + Message> PartialEq<NSMutableDictionary<K, V>> for NSMutableDictionary<K, V>

fn eq(&self, other: &NSMutableDictionary<K, V>) -> 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<K: Message, V: Message> RefEncode for NSMutableDictionary<K, V>

const ENCODING_REF: Encoding = <NSDictionary<K, V> as crate::RefEncode>::ENCODING_REF

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

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>