Struct objc2_foundation::NSDictionary

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

Available on crate feature NSDictionary only.

Implementations

impl<K: Message + Eq + Hash + HasStableHash, V: Message> NSDictionary<K, V>

pub fn from_vec<Q>(keys: &[&Q], objects: Vec<Retained<V>>) -> Retained<Self>

where Q: Message + NSCopying + CounterpartOrSelf<Immutable = K>,

Available on crate feature NSObject only.

pub fn from_id_slice<Q>(keys: &[&Q], objects: &[Retained<V>]) -> Retained<Self>

where Q: Message + NSCopying + CounterpartOrSelf<Immutable = K>, V: IsIdCloneable,

Available on crate feature NSObject only.

pub fn from_slice<Q>(keys: &[&Q], objects: &[&V]) -> Retained<Self>

where Q: Message + NSCopying + CounterpartOrSelf<Immutable = K>, V: IsRetainable,

Available on crate feature NSObject only.

impl<K: Message + Eq + Hash, V: Message> NSDictionary<K, V>

pub fn get(&self, key: &K) -> Option<&V>

pub fn get_retained(&self, key: &K) -> Option<Retained<V>>

where V: IsIdCloneable,

pub fn get_mut(&mut self, key: &K) -> Option<&mut V>

where V: IsMutable,

Returns a mutable reference to the value corresponding to the key.

Examples

 use objc2_foundation::{ns_string, NSMutableDictionary, NSMutableString, NSString};

 let mut dict = NSMutableDictionary::new();
 dict.insert_id(ns_string!("one"), NSMutableString::new());
 println!("{:?}", dict.get_mut(ns_string!("one")));

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

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn keys_vec(&self) -> Vec<&K>

pub fn values_vec(&self) -> Vec<&V>

pub fn values_vec_mut(&mut self) -> Vec<&mut V>

where V: IsMutable,

Returns a vector of mutable references to the values in the dictionary.

Examples

use objc2_foundation::{ns_string, NSMutableDictionary, NSMutableString, NSString};

let mut dict = NSMutableDictionary::new();
dict.insert_id(ns_string!("one"), NSMutableString::from_str("two"));
for val in dict.values_mut() {
    println!("{:?}", val);
}

pub fn to_vecs(&self) -> (Vec<&K>, Vec<&V>)

pub fn to_array(&self) -> Retained<NSArray<V>>

where V: IsIdCloneable,

Available on crate feature NSArray only.

Returns an NSArray containing the dictionary’s values.

Examples

use objc2_foundation::{ns_string, NSMutableDictionary, NSObject, NSString};

let mut dict = NSMutableDictionary::new();
dict.insert_id(ns_string!("one"), NSObject::new());
let array = dict.to_array();
assert_eq!(array.len(), 1);

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

pub fn keys(&self) -> Keys<'_, K, V>

Available on crate feature NSEnumerator only.

pub fn keys_retained(&self) -> KeysRetained<'_, K, V>

where K: IsIdCloneable,

Available on crate feature NSEnumerator only.

pub fn values(&self) -> Values<'_, K, V>

Available on crate feature NSEnumerator only.

pub fn values_mut(&mut self) -> ValuesMut<'_, K, V>

where V: IsMutable,

Available on crate feature NSEnumerator only.

pub fn values_retained(&self) -> ValuesRetained<'_, K, V>

where V: IsIdCloneable,

Available on crate feature NSEnumerator only.

pub fn into_values(this: Retained<Self>) -> IntoValues<K, V>

where V: IsIdCloneable,

Available on crate feature NSEnumerator only.

impl<KeyType: Message, ObjectType: Message> NSDictionary<KeyType, ObjectType>

pub fn count(&self) -> NSUInteger

pub unsafe fn objectForKey( &self, a_key: &KeyType ) -> Option<Retained<ObjectType>>

pub unsafe fn keyEnumerator(&self) -> Retained<NSEnumerator<KeyType>>

Available on crate feature NSEnumerator only.

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

pub unsafe fn initWithObjects_forKeys_count( this: Allocated<Self>, objects: *mut NonNull<ObjectType>, keys: *mut NonNull<ProtocolObject<dyn NSCopying>>, cnt: NSUInteger ) -> Retained<Self>

Available on crate feature NSObject only.

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

Available on crate feature NSCoder only.

impl<KeyType: Message, ObjectType: Message> NSDictionary<KeyType, ObjectType>

Methods declared on superclass NSObject

pub fn new() -> Retained<Self>

impl<KeyType: Message, ObjectType: Message> NSDictionary<KeyType, ObjectType>

NSExtendedDictionary

pub unsafe fn allKeys(&self) -> Retained<NSArray<KeyType>>

Available on crate feature NSArray only.

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

Available on crate feature NSArray only.

pub unsafe fn allValues(&self) -> Retained<NSArray<ObjectType>>

Available on crate feature NSArray only.

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

Available on crate feature NSString only.

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

Available on crate feature NSString only.

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

Available on crate feature NSString only.

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

Available on crate feature NSString only.

pub unsafe fn isEqualToDictionary( &self, other_dictionary: &NSDictionary<KeyType, ObjectType> ) -> bool

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

Available on crate feature NSEnumerator only.

pub unsafe fn objectsForKeys_notFoundMarker( &self, keys: &NSArray<KeyType>, marker: &ObjectType ) -> Retained<NSArray<ObjectType>>

Available on crate feature NSArray only.

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

Available on crate features NSError and NSURL only.

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

Available on crate feature NSArray only.

pub unsafe fn getObjects_andKeys_count( &self, objects: *mut NonNull<ObjectType>, keys: *mut NonNull<KeyType>, count: NSUInteger )

pub unsafe fn objectForKeyedSubscript( &self, key: &KeyType ) -> Option<Retained<ObjectType>>

pub unsafe fn enumerateKeysAndObjectsUsingBlock( &self, block: &Block<dyn Fn(NonNull<KeyType>, NonNull<ObjectType>, NonNull<Bool>) + '_> )

Available on crate feature block2 only.

pub unsafe fn enumerateKeysAndObjectsWithOptions_usingBlock( &self, opts: NSEnumerationOptions, block: &Block<dyn Fn(NonNull<KeyType>, NonNull<ObjectType>, NonNull<Bool>) + '_> )

Available on crate features NSObjCRuntime and block2 only.

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

Available on crate features NSArray and NSObjCRuntime and block2 only.

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

Available on crate features NSArray and NSObjCRuntime and block2 only.

pub unsafe fn keysOfEntriesPassingTest( &self, predicate: &Block<dyn Fn(NonNull<KeyType>, NonNull<ObjectType>, NonNull<Bool>) -> Bool + '_> ) -> Retained<NSSet<KeyType>>

Available on crate features NSSet and block2 only.

pub unsafe fn keysOfEntriesWithOptions_passingTest( &self, opts: NSEnumerationOptions, predicate: &Block<dyn Fn(NonNull<KeyType>, NonNull<ObjectType>, NonNull<Bool>) -> Bool + '_> ) -> Retained<NSSet<KeyType>>

Available on crate features NSObjCRuntime and NSSet and block2 only.

impl<KeyType: Message, ObjectType: Message> NSDictionary<KeyType, ObjectType>

NSDeprecated

pub unsafe fn getObjects_andKeys( &self, objects: *mut NonNull<ObjectType>, keys: *mut NonNull<KeyType> )

👎Deprecated: Use -getObjects:andKeys:count: instead

pub unsafe fn dictionaryWithContentsOfFile( path: &NSString ) -> Option<Retained<NSDictionary<KeyType, ObjectType>>>

👎Deprecated

Available on crate feature NSString only.

pub unsafe fn dictionaryWithContentsOfURL( url: &NSURL ) -> Option<Retained<NSDictionary<KeyType, ObjectType>>>

👎Deprecated

Available on crate feature NSURL only.

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

👎Deprecated

Available on crate feature NSString only.

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

👎Deprecated

Available on crate feature NSURL only.

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

👎Deprecated

Available on crate feature NSString only.

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

👎Deprecated

Available on crate feature NSURL only.

impl<KeyType: Message, ObjectType: Message> NSDictionary<KeyType, ObjectType>

NSDictionaryCreation

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

pub unsafe fn dictionaryWithObject_forKey( object: &ObjectType, key: &ProtocolObject<dyn NSCopying> ) -> Retained<Self>

Available on crate feature NSObject only.

pub unsafe fn dictionaryWithObjects_forKeys_count( objects: *mut NonNull<ObjectType>, keys: *mut NonNull<ProtocolObject<dyn NSCopying>>, cnt: NSUInteger ) -> Retained<Self>

Available on crate feature NSObject only.

pub unsafe fn dictionaryWithDictionary( dict: &NSDictionary<KeyType, ObjectType> ) -> Retained<Self>

pub unsafe fn dictionaryWithObjects_forKeys( objects: &NSArray<ObjectType>, keys: &NSArray<ProtocolObject<dyn NSCopying>> ) -> Retained<Self>

Available on crate features NSArray and NSObject only.

pub unsafe fn initWithDictionary( this: Allocated<Self>, other_dictionary: &NSDictionary<KeyType, ObjectType> ) -> Retained<Self>

pub unsafe fn initWithDictionary_copyItems( this: Allocated<Self>, other_dictionary: &NSDictionary<KeyType, ObjectType>, flag: bool ) -> Retained<Self>

pub unsafe fn initWithObjects_forKeys( this: Allocated<Self>, objects: &NSArray<ObjectType>, keys: &NSArray<ProtocolObject<dyn NSCopying>> ) -> Retained<Self>

Available on crate features NSArray and NSObject only.

impl<KeyType: Message, ObjectType: Message> NSDictionary<KeyType, ObjectType>

NSSharedKeySetDictionary

pub unsafe fn sharedKeySetForKeys( keys: &NSArray<ProtocolObject<dyn NSCopying>> ) -> Retained<AnyObject>

Available on crate features NSArray and NSObject only.

impl<KeyType: Message, ObjectType: Message> NSDictionary<KeyType, ObjectType>

NSFileAttributes

pub unsafe fn fileSize(&self) -> c_ulonglong

Available on crate feature NSFileManager only.

pub unsafe fn fileModificationDate(&self) -> Option<Retained<NSDate>>

Available on crate features NSFileManager and NSDate only.

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

Available on crate features NSFileManager and NSString only.

pub unsafe fn filePosixPermissions(&self) -> NSUInteger

Available on crate feature NSFileManager only.

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

Available on crate features NSFileManager and NSString only.

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

Available on crate features NSFileManager and NSString only.

pub unsafe fn fileSystemNumber(&self) -> NSInteger

Available on crate feature NSFileManager only.

pub unsafe fn fileSystemFileNumber(&self) -> NSUInteger

Available on crate feature NSFileManager only.

pub unsafe fn fileExtensionHidden(&self) -> bool

Available on crate feature NSFileManager only.

pub unsafe fn fileHFSCreatorCode(&self) -> OSType

Available on crate feature NSFileManager only.

pub unsafe fn fileHFSTypeCode(&self) -> OSType

Available on crate feature NSFileManager only.

pub unsafe fn fileIsImmutable(&self) -> bool

Available on crate feature NSFileManager only.

pub unsafe fn fileIsAppendOnly(&self) -> bool

Available on crate feature NSFileManager only.

pub unsafe fn fileCreationDate(&self) -> Option<Retained<NSDate>>

Available on crate features NSFileManager and NSDate only.

pub unsafe fn fileOwnerAccountID(&self) -> Option<Retained<NSNumber>>

Available on crate features NSFileManager and NSValue only.

pub unsafe fn fileGroupOwnerAccountID(&self) -> Option<Retained<NSNumber>>

Available on crate features NSFileManager and NSValue only.

impl<KeyType: Message, ObjectType: Message> NSDictionary<KeyType, ObjectType>

NSKeyValueCoding

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

Available on crate features NSKeyValueCoding and NSString only.

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<KeyType: ?Sized + Message, ObjectType: ?Sized + Message> AsMut<AnyObject> for NSDictionary<KeyType, ObjectType>

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

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

impl<KeyType: ?Sized + Message, ObjectType: ?Sized + Message> AsMut<NSDictionary<KeyType, ObjectType>> for NSDictionary<KeyType, ObjectType>

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

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

impl<KeyType: ?Sized + Message, ObjectType: ?Sized + Message> AsMut<NSDictionary<KeyType, ObjectType>> for NSMutableDictionary<KeyType, ObjectType>

fn as_mut(&mut self) -> &mut NSDictionary<KeyType, ObjectType>

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

impl<KeyType: ?Sized + Message, ObjectType: ?Sized + Message> AsMut<NSObject> for NSDictionary<KeyType, ObjectType>

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

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

impl<KeyType: ?Sized + Message, ObjectType: ?Sized + Message> AsRef<AnyObject> for NSDictionary<KeyType, ObjectType>

fn as_ref(&self) -> &AnyObject

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

impl<KeyType: ?Sized + Message, ObjectType: ?Sized + Message> AsRef<NSDictionary<KeyType, ObjectType>> for NSDictionary<KeyType, ObjectType>

fn as_ref(&self) -> &Self

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

impl<KeyType: ?Sized + Message, ObjectType: ?Sized + Message> AsRef<NSDictionary<KeyType, ObjectType>> for NSMutableDictionary<KeyType, ObjectType>

fn as_ref(&self) -> &NSDictionary<KeyType, ObjectType>

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

impl<KeyType: ?Sized + Message, ObjectType: ?Sized + Message> AsRef<NSObject> for NSDictionary<KeyType, ObjectType>

fn as_ref(&self) -> &NSObject

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

impl<KeyType: ?Sized + Message, ObjectType: ?Sized + Message> Borrow<AnyObject> for NSDictionary<KeyType, ObjectType>

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl<KeyType: ?Sized + Message, ObjectType: ?Sized + Message> Borrow<NSDictionary<KeyType, ObjectType>> for NSMutableDictionary<KeyType, ObjectType>

fn borrow(&self) -> &NSDictionary<KeyType, ObjectType>

Immutably borrows from an owned value.

impl<KeyType: ?Sized + Message, ObjectType: ?Sized + Message> Borrow<NSObject> for NSDictionary<KeyType, ObjectType>

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl<KeyType: ?Sized + Message, ObjectType: ?Sized + Message> BorrowMut<AnyObject> for NSDictionary<KeyType, ObjectType>

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

Mutably borrows from an owned value.

impl<KeyType: ?Sized + Message, ObjectType: ?Sized + Message> BorrowMut<NSDictionary<KeyType, ObjectType>> for NSMutableDictionary<KeyType, ObjectType>

fn borrow_mut(&mut self) -> &mut NSDictionary<KeyType, ObjectType>

Mutably borrows from an owned value.

impl<KeyType: ?Sized + Message, ObjectType: ?Sized + Message> BorrowMut<NSObject> for NSDictionary<KeyType, ObjectType>

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

Mutably borrows from an owned value.

impl<KeyType: ?Sized + Message, ObjectType: ?Sized + Message> ClassType for NSDictionary<KeyType, ObjectType>

type Super = NSObject

The superclass of this class.

type Mutability = ImmutableWithMutableSubclass<NSMutableDictionary<KeyType, ObjectType>>

Whether the type is mutable or immutable.

const NAME: &'static str = "NSDictionary"

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

fn class() -> &'static AnyClass

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.

fn alloc() -> Allocated<Self>

where Self: Sized + IsAllocableAnyThread,

Allocate a new instance of the class.

impl<K: Debug + Message, V: Debug + Message> Debug for NSDictionary<K, V>

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

Formats the value using the given formatter.

impl<KeyType: Message, ObjectType: Message> DefaultRetained for NSDictionary<KeyType, ObjectType>

fn default_id() -> Retained<Self>

The default Retained for a type.

fn default_retained() -> Retained<Self>

The default Retained for a type.

impl<KeyType: ?Sized + Message, ObjectType: ?Sized + Message> Deref for NSDictionary<KeyType, ObjectType>

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl<KeyType: ?Sized + Message, ObjectType: ?Sized + Message> DerefMut for NSDictionary<KeyType, ObjectType>

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

Mutably dereferences the value.

impl<KeyType: Hash + ?Sized, ObjectType: Hash + ?Sized> Hash for NSDictionary<KeyType, ObjectType>

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 + Eq + Hash, V: Message> Index<&'a K> for NSDictionary<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 + Eq + Hash, V: Message + IsMutable> IndexMut<&'a K> for NSDictionary<K, V>

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

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

impl<KeyType: PartialEq + ?Sized, ObjectType: PartialEq + ?Sized> PartialEq for NSDictionary<KeyType, ObjectType>

fn eq(&self, other: &NSDictionary<KeyType, ObjectType>) -> 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<KeyType: ?Sized + Message, ObjectType: ?Sized + Message> RefEncode for NSDictionary<KeyType, ObjectType>

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

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

impl<KeyType: Eq + ?Sized, ObjectType: Eq + ?Sized> Eq for NSDictionary<KeyType, ObjectType>

impl<KeyType: ?Sized + Message, ObjectType: ?Sized + Message> Message for NSDictionary<KeyType, ObjectType>

impl<KeyType: ?Sized + NSCoding, ObjectType: ?Sized + NSCoding> NSCoding for NSDictionary<KeyType, ObjectType>

Available on crate feature NSObject only.

impl<KeyType: ?Sized + IsIdCloneable, ObjectType: ?Sized + IsIdCloneable> NSCopying for NSDictionary<KeyType, ObjectType>

Available on crate feature NSObject only.

impl<KeyType: ?Sized, ObjectType: ?Sized> NSFastEnumeration for NSDictionary<KeyType, ObjectType>

Available on crate feature NSEnumerator only.

impl<KeyType: ?Sized + IsIdCloneable, ObjectType: ?Sized + IsIdCloneable> NSMutableCopying for NSDictionary<KeyType, ObjectType>

Available on crate feature NSObject only.

impl<KeyType: ?Sized, ObjectType: ?Sized> NSObjectProtocol for NSDictionary<KeyType, ObjectType>

impl<KeyType: ?Sized + NSSecureCoding, ObjectType: ?Sized + NSSecureCoding> NSSecureCoding for NSDictionary<KeyType, ObjectType>

Available on crate feature NSObject only.

impl<KeyType: ?Sized, ObjectType: ?Sized> StructuralPartialEq for NSDictionary<KeyType, ObjectType>