Struct CFDictionary 

#[repr(C)]
pub struct CFDictionary<K: ?Sized = Opaque, V: ?Sized = Opaque> { /* private fields */ }

Available on crate feature CFDictionary only.

This is the type of a reference to immutable CFDictionarys.

See also Apple’s documentation

Implementations

impl<K: ?Sized, V: ?Sized> CFDictionary<K, V>

Convenience creation methods.

pub fn empty() -> CFRetained<Self>

where K: Type + PartialEq + Hash, V: Type,

Create a new empty dictionary.

pub fn from_slices(keys: &[&K], values: &[&V]) -> CFRetained<Self>

where K: Type + PartialEq + Hash, V: Type,

Create a new dictionary from slices of keys and values.

Panics

Panics if the slices have different lengths.

impl<K: ?Sized, V: ?Sized> CFDictionary<K, V>

Direct, unsafe object accessors.

CFDictionary stores its keys and values directly, and you can get references to those without having to retain them first - but only if the dictionary isn’t mutated while doing so - otherwise, you might end up accessing a deallocated object.

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

where K: Type + Sized, V: Type + Sized,

Get a direct reference to one of the dictionary’s values.

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

Safety

The dictionary must not be mutated while the returned reference is live.

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

where K: Type, V: Type,

Available on crate feature alloc only.

A vector containing direct references to the dictionary’s keys and values.

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

Safety

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

impl<K: ?Sized, V: ?Sized> CFDictionary<K, V>

Various accessor methods.

pub fn as_opaque(&self) -> &CFDictionary

Convert to the opaque/untyped variant.

pub fn len(&self) -> usize

The amount of elements in the dictionary.

pub fn is_empty(&self) -> bool

Whether the dictionary is empty or not.

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

where K: Type + Sized + PartialEq + Hash, V: Type + Sized,

Retrieve the object at the given index.

Returns None if the index was out of bounds.

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

where K: Type + Sized, V: Type + Sized,

Available on crate feature alloc only.

Two vectors containing respectively the dictionary’s keys and values.

pub fn contains_key(&self, key: &K) -> bool

where K: Type + Sized + PartialEq + Hash,

Whether the key is in the dictionary.

pub fn contains_value(&self, value: &V) -> bool

where V: Type + Sized + PartialEq,

Whether the value can be found anywhere in the dictionary.

impl CFDictionary

pub unsafe fn new( allocator: Option<&CFAllocator>, keys: *mut *const c_void, values: *mut *const c_void, num_values: CFIndex, key_call_backs: *const CFDictionaryKeyCallBacks, value_call_backs: *const CFDictionaryValueCallBacks, ) -> Option<CFRetained<CFDictionary>>

Creates a new immutable dictionary with the given values.

Parameter allocator: The CFAllocator which should be used to allocate memory for the dictionary and its storage for values. This parameter may be NULL in which case the current default CFAllocator is used. If this reference is not a valid CFAllocator, the behavior is undefined.

Parameter keys: A C array of the pointer-sized keys to be used for the parallel C array of values to be put into the dictionary. This parameter may be NULL if the numValues parameter is 0. This C array is not changed or freed by this function. If this parameter is not a valid pointer to a C array of at least numValues pointers, the behavior is undefined.

Parameter values: A C array of the pointer-sized values to be in the dictionary. This parameter may be NULL if the numValues parameter is 0. This C array is not changed or freed by this function. If this parameter is not a valid pointer to a C array of at least numValues pointers, the behavior is undefined.

Parameter numValues: The number of values to copy from the keys and values C arrays into the CFDictionary. This number will be the count of the dictionary. If this parameter is negative, or greater than the number of values actually in the keys or values C arrays, the behavior is undefined.

Parameter keyCallBacks: A pointer to a CFDictionaryKeyCallBacks structure initialized with the callbacks for the dictionary to use on each key in the dictionary. The retain callback will be used within this function, for example, to retain all of the new keys from the keys C array. A copy of the contents of the callbacks structure is made, so that a pointer to a structure on the stack can be passed in, or can be reused for multiple dictionary creations. If the version field of this callbacks structure is not one of the defined ones for CFDictionary, the behavior is undefined. The retain field may be NULL, in which case the CFDictionary will do nothing to add a retain to the keys of the contained values. The release field may be NULL, in which case the CFDictionary will do nothing to remove the dictionary’s retain (if any) on the keys when the dictionary is destroyed or a key-value pair is removed. If the copyDescription field is NULL, the dictionary will create a simple description for a key. If the equal field is NULL, the dictionary will use pointer equality to test for equality of keys. If the hash field is NULL, a key will be converted from a pointer to an integer to compute the hash code. This callbacks parameter itself may be NULL, which is treated as if a valid structure of version 0 with all fields NULL had been passed in. Otherwise, if any of the fields are not valid pointers to functions of the correct type, or this parameter is not a valid pointer to a CFDictionaryKeyCallBacks callbacks structure, the behavior is undefined. If any of the keys put into the dictionary is not one understood by one of the callback functions the behavior when that callback function is used is undefined.

Parameter valueCallBacks: A pointer to a CFDictionaryValueCallBacks structure initialized with the callbacks for the dictionary to use on each value in the dictionary. The retain callback will be used within this function, for example, to retain all of the new values from the values C array. A copy of the contents of the callbacks structure is made, so that a pointer to a structure on the stack can be passed in, or can be reused for multiple dictionary creations. If the version field of this callbacks structure is not one of the defined ones for CFDictionary, the behavior is undefined. The retain field may be NULL, in which case the CFDictionary will do nothing to add a retain to values as they are put into the dictionary. The release field may be NULL, in which case the CFDictionary will do nothing to remove the dictionary’s retain (if any) on the values when the dictionary is destroyed or a key-value pair is removed. If the copyDescription field is NULL, the dictionary will create a simple description for a value. If the equal field is NULL, the dictionary will use pointer equality to test for equality of values. This callbacks parameter itself may be NULL, which is treated as if a valid structure of version 0 with all fields NULL had been passed in. Otherwise, if any of the fields are not valid pointers to functions of the correct type, or this parameter is not a valid pointer to a CFDictionaryValueCallBacks callbacks structure, the behavior is undefined. If any of the values put into the dictionary is not one understood by one of the callback functions the behavior when that callback function is used is undefined.

Returns: A reference to the new immutable CFDictionary.

pub fn new_copy( allocator: Option<&CFAllocator>, the_dict: Option<&CFDictionary>, ) -> Option<CFRetained<CFDictionary>>

Creates a new immutable dictionary with the key-value pairs from the given dictionary.

Parameter allocator: The CFAllocator which should be used to allocate memory for the dictionary and its storage for values. This parameter may be NULL in which case the current default CFAllocator is used. If this reference is not a valid CFAllocator, the behavior is undefined.

Parameter theDict: The dictionary which is to be copied. The keys and values from the dictionary are copied as pointers into the new dictionary (that is, the values themselves are copied, not that which the values point to, if anything). However, the keys and values are also retained by the new dictionary using the retain function of the original dictionary. The count of the new dictionary will be the same as the given dictionary. The new dictionary uses the same callbacks as the dictionary to be copied. If this parameter is not a valid CFDictionary, the behavior is undefined.

Returns: A reference to the new immutable CFDictionary.

impl CFDictionary

pub fn count(self: &CFDictionary) -> CFIndex

Returns the number of values currently in the dictionary.

Parameter theDict: The dictionary to be queried. If this parameter is not a valid CFDictionary, the behavior is undefined.

Returns: The number of values in the dictionary.

pub unsafe fn count_of_key(self: &CFDictionary, key: *const c_void) -> CFIndex

Counts the number of times the given key occurs in the dictionary.

Parameter theDict: The dictionary to be searched. If this parameter is not a valid CFDictionary, the behavior is undefined.

Parameter key: The key for which to find matches in the dictionary. The hash() and equal() key callbacks provided when the dictionary was created are used to compare. If the hash() key callback was NULL, the key is treated as a pointer and converted to an integer. If the equal() key callback was NULL, pointer equality (in C, ==) is used. If key, or any of the keys in the dictionary, are not understood by the equal() callback, the behavior is undefined.

Returns: Returns 1 if a matching key is used by the dictionary, 0 otherwise.

pub unsafe fn count_of_value( self: &CFDictionary, value: *const c_void, ) -> CFIndex

Counts the number of times the given value occurs in the dictionary.

Parameter theDict: The dictionary to be searched. If this parameter is not a valid CFDictionary, the behavior is undefined.

Parameter value: The value for which to find matches in the dictionary. The equal() callback provided when the dictionary was created is used to compare. If the equal() value callback was NULL, pointer equality (in C, ==) is used. If value, or any of the values in the dictionary, are not understood by the equal() callback, the behavior is undefined.

Returns: The number of times the given value occurs in the dictionary.

pub unsafe fn contains_ptr_key(self: &CFDictionary, key: *const c_void) -> bool

Reports whether or not the key is in the dictionary.

Parameter theDict: The dictionary to be searched. If this parameter is not a valid CFDictionary, the behavior is undefined.

Parameter key: The key for which to find matches in the dictionary. The hash() and equal() key callbacks provided when the dictionary was created are used to compare. If the hash() key callback was NULL, the key is treated as a pointer and converted to an integer. If the equal() key callback was NULL, pointer equality (in C, ==) is used. If key, or any of the keys in the dictionary, are not understood by the equal() callback, the behavior is undefined.

Returns: true, if the key is in the dictionary, otherwise false.

pub unsafe fn contains_ptr_value( self: &CFDictionary, value: *const c_void, ) -> bool

Reports whether or not the value is in the dictionary.

Parameter theDict: The dictionary to be searched. If this parameter is not a valid CFDictionary, the behavior is undefined.

Parameter value: The value for which to find matches in the dictionary. The equal() callback provided when the dictionary was created is used to compare. If the equal() callback was NULL, pointer equality (in C, ==) is used. If value, or any of the values in the dictionary, are not understood by the equal() callback, the behavior is undefined.

Returns: true, if the value is in the dictionary, otherwise false.

pub unsafe fn value(self: &CFDictionary, key: *const c_void) -> *const c_void

Retrieves the value associated with the given key.

Parameter theDict: The dictionary to be queried. If this parameter is not a valid CFDictionary, the behavior is undefined.

Parameter key: The key for which to find a match in the dictionary. The hash() and equal() key callbacks provided when the dictionary was created are used to compare. If the hash() key callback was NULL, the key is treated as a pointer and converted to an integer. If the equal() key callback was NULL, pointer equality (in C, ==) is used. If key, or any of the keys in the dictionary, are not understood by the equal() callback, the behavior is undefined.

Returns: The value with the given key in the dictionary, or NULL if no key-value pair with a matching key exists. Since NULL can be a valid value in some dictionaries, the function CFDictionaryGetValueIfPresent() must be used to distinguish NULL-no-found from NULL-is-the-value.

pub unsafe fn value_if_present( self: &CFDictionary, key: *const c_void, value: *mut *const c_void, ) -> bool

Retrieves the value associated with the given key.

Parameter theDict: The dictionary to be queried. If this parameter is not a valid CFDictionary, the behavior is undefined.

Parameter key: The key for which to find a match in the dictionary. The hash() and equal() key callbacks provided when the dictionary was created are used to compare. If the hash() key callback was NULL, the key is treated as a pointer and converted to an integer. If the equal() key callback was NULL, pointer equality (in C, ==) is used. If key, or any of the keys in the dictionary, are not understood by the equal() callback, the behavior is undefined.

Parameter value: A pointer to memory which should be filled with the pointer-sized value if a matching key is found. If no key match is found, the contents of the storage pointed to by this parameter are undefined. This parameter may be NULL, in which case the value from the dictionary is not returned (but the return value of this function still indicates whether or not the key-value pair was present).

Returns: true, if a matching key was found, false otherwise.

pub unsafe fn keys_and_values( self: &CFDictionary, keys: *mut *const c_void, values: *mut *const c_void, )

Fills the two buffers with the keys and values from the dictionary.

Parameter theDict: The dictionary to be queried. If this parameter is not a valid CFDictionary, the behavior is undefined.

Parameter keys: A C array of pointer-sized values to be filled with keys from the dictionary. The keys and values C arrays are parallel to each other (that is, the items at the same indices form a key-value pair from the dictionary). This parameter may be NULL if the keys are not desired. If this parameter is not a valid pointer to a C array of at least CFDictionaryGetCount() pointers, or NULL, the behavior is undefined.

Parameter values: A C array of pointer-sized values to be filled with values from the dictionary. The keys and values C arrays are parallel to each other (that is, the items at the same indices form a key-value pair from the dictionary). This parameter may be NULL if the values are not desired. If this parameter is not a valid pointer to a C array of at least CFDictionaryGetCount() pointers, or NULL, the behavior is undefined.

pub unsafe fn apply_function( self: &CFDictionary, applier: CFDictionaryApplierFunction, context: *mut c_void, )

Calls a function once for each value in the dictionary.

Parameter theDict: The dictionary to be queried. If this parameter is not a valid CFDictionary, the behavior is undefined.

Parameter applier: The callback function to call once for each value in the dictionary. If this parameter is not a pointer to a function of the correct prototype, the behavior is undefined. If there are keys or values which the applier function does not expect or cannot properly apply to, the behavior is undefined.

Parameter context: A pointer-sized user-defined value, which is passed as the third parameter to the applier function, but is otherwise unused by this function. If the context is not what is expected by the applier function, the behavior is undefined.

Methods from Deref<Target = CFType>

pub fn downcast_ref<T: ConcreteType>(&self) -> Option<&T>

Attempt to downcast the type to that of type T.

This is the reference-variant. Use CFRetained::downcast if you want to convert a retained type. See also ConcreteType for more details on which types support being converted to.

pub fn retain_count(&self) -> usize

Get the reference count of the object.

This function may be useful for debugging. You normally do not use this function otherwise.

Beware that some things (like CFNumbers, small CFStrings etc.) may not have a normal retain count for optimization purposes, and can return usize::MAX in that case.

Trait Implementations

impl<K: ?Sized, V: ?Sized> AsRef<AnyObject> for CFDictionary<K, V>

fn as_ref(&self) -> &AnyObject

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

impl<K: ?Sized, V: ?Sized> AsRef<CFDictionary<K, V>> for CFDictionary<K, V>

fn as_ref(&self) -> &Self

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

impl<K: ?Sized, V: ?Sized> AsRef<CFDictionary<K, V>> for CFMutableDictionary<K, V>

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

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

impl<K: ?Sized + Type, V: ?Sized + Type> AsRef<CFDictionary> for CFDictionary<K, V>

fn as_ref(&self) -> &CFDictionary

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

impl<K: ?Sized, V: ?Sized> AsRef<CFType> for CFDictionary<K, V>

fn as_ref(&self) -> &CFType

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

impl<K: ?Sized, V: ?Sized> Borrow<AnyObject> for CFDictionary<K, V>

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl<K: ?Sized, V: ?Sized> Borrow<CFDictionary<K, V>> for CFMutableDictionary<K, V>

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

Immutably borrows from an owned value.

impl<K: ?Sized + Type, V: ?Sized + Type> Borrow<CFDictionary> for CFDictionary<K, V>

fn borrow(&self) -> &CFDictionary

Immutably borrows from an owned value.

impl<K: ?Sized, V: ?Sized> Borrow<CFType> for CFDictionary<K, V>

fn borrow(&self) -> &CFType

Immutably borrows from an owned value.

impl ConcreteType for CFDictionary

fn type_id() -> CFTypeID

Returns the type identifier of all CFDictionary instances.

impl<K: ?Sized, V: ?Sized> Debug for CFDictionary<K, V>

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

Formats the value using the given formatter.

impl<K: ?Sized, V: ?Sized> Deref for CFDictionary<K, V>

type Target = CFType

The resulting type after dereferencing.

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

Dereferences the value.

impl<K: ?Sized, V: ?Sized> Hash for CFDictionary<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<K: ?Sized, V: ?Sized> Message for CFDictionary<K, V>

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl<K: ?Sized, V: ?Sized> PartialEq for CFDictionary<K, V>

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<K: ?Sized, V: ?Sized> RefEncode for CFDictionary<K, V>

const ENCODING_REF: Encoding

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

impl<K: ?Sized, V: ?Sized> Type for CFDictionary<K, V>

fn retain(&self) -> CFRetained<Self>

where Self: Sized,

Increment the reference count of the receiver.

fn as_concrete_TypeRef(&self) -> &Self

👎Deprecated: this is redundant

Helper for easier transition from the core-foundation crate.

unsafe fn wrap_under_get_rule(ptr: *const Self) -> CFRetained<Self>

where Self: Sized,

👎Deprecated: use CFRetained::retain

Helper for easier transition from the core-foundation crate.

fn as_CFTypeRef(&self) -> &CFType

where Self: AsRef<CFType>,

👎Deprecated: this is redundant (CF types deref to CFType)

Helper for easier transition from the core-foundation crate.

unsafe fn wrap_under_create_rule(ptr: *const Self) -> CFRetained<Self>

where Self: Sized,

👎Deprecated: use CFRetained::from_raw

Helper for easier transition from the core-foundation crate.

impl<K: ?Sized, V: ?Sized> Eq for CFDictionary<K, V>