Struct core_foundation::dictionary::CFDictionary

pub struct CFDictionary<K = *const c_void, V = *const c_void>(_, _, _);

Methods

impl<K, V> CFDictionary<K, V>

pub fn from_CFType_pairs(pairs: &[(K, V)]) -> CFDictionary<K, V> where
    K: TCFType,
    V: TCFType, 

pub fn to_untyped(&self) -> CFDictionary

pub unsafe fn to_mutable(&self) -> CFMutableDictionary<K, V>

Returns a CFMutableDictionary pointing to the same underlying dictionary as this immutable one. This should only be used when the underlying dictionary is mutable.

pub fn into_untyped(self) -> CFDictionary

Returns the same dictionary, but with the types reset to void pointers. Equal to to_untyped, but is faster since it does not increment the retain count.

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

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

pub fn find<'a, T: ToVoid<K>>(&'a self, key: T) -> Option<ItemRef<'a, V>> where
    V: FromVoid,
    K: ToVoid<K>, 

pub fn get<'a, T: ToVoid<K>>(&'a self, key: T) -> ItemRef<'a, V> where
    V: FromVoid,
    K: ToVoid<K>, 

Panics

Panics if the key is not present in the dictionary. Use find to get an Option instead of panicking.

pub fn get_keys_and_values(&self) -> (Vec<*const c_void>, Vec<*const c_void>)

Trait Implementations

impl ConcreteCFType for CFDictionary<*const c_void, *const c_void>

impl<K, V> TCFType for CFDictionary<K, V>

type Ref = CFDictionaryRef

The reference type wrapped inside this type.

fn as_concrete_TypeRef(&self) -> CFDictionaryRef

Returns the object as its concrete TypeRef.

unsafe fn wrap_under_get_rule(reference: CFDictionaryRef) -> Self

Returns an instance of the object, wrapping the underlying CFTypeRef subclass. Use this when following Core Foundation's "Get Rule". The reference count is bumped.

fn as_CFTypeRef(&self) -> CFTypeRef

Returns the object as a raw CFTypeRef. The reference count is not adjusted.

unsafe fn wrap_under_create_rule(reference: CFDictionaryRef) -> Self

Returns an instance of the object, wrapping the underlying CFTypeRef subclass. Use this when following Core Foundation's "Create Rule". The reference count is not bumped.

fn type_id() -> CFTypeID

Returns the type ID for this class.

fn as_CFType(&self) -> CFType

Returns the object as a wrapped CFType. The reference count is incremented by one.

fn into_CFType(self) -> CFType where
    Self: Sized, 

Returns the object as a wrapped CFType. Consumes self and avoids changing the reference count.

fn retain_count(&self) -> CFIndex

Returns the reference count of the object. It is unwise to do anything other than test whether the return value of this method is greater than zero.

fn type_of(&self) -> CFTypeID

Returns the type ID of this object.

fn show(&self)

Writes a debugging version of this object on standard error.

fn instance_of<OtherCFType: TCFType>(&self) -> bool

Returns true if this value is an instance of another type.

impl<'a> ToVoid<CFDictionary<*const c_void, *const c_void>> for &'a CFDictionary

fn to_void(&self) -> *const c_void

impl ToVoid<CFDictionary<*const c_void, *const c_void>> for CFDictionary

fn to_void(&self) -> *const c_void

impl ToVoid<CFDictionary<*const c_void, *const c_void>> for CFDictionaryRef

fn to_void(&self) -> *const c_void

impl CFPropertyListSubClass for CFDictionary

fn to_CFPropertyList(&self) -> CFPropertyList

Create an instance of the superclass type [CFPropertyList] for this instance.

fn into_CFPropertyList(self) -> CFPropertyList where
    Self: Sized, 

Equal to [to_CFPropertyList], but consumes self and avoids changing the reference count.

impl<K, V> Drop for CFDictionary<K, V>

fn drop(&mut self)

Executes the destructor for this type.

impl PartialEq<CFDictionary<*const c_void, *const c_void>> for CFDictionary

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

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

This method tests for !=.

impl<'a, K, V> From<&'a CFDictionary<K, V>> for CFMutableDictionary<K, V>

fn from(dict: &'a CFDictionary<K, V>) -> Self

Creates a new mutable dictionary with the key-value pairs from another dictionary. The capacity of the new mutable dictionary is not limited.

impl Clone for CFDictionary

fn clone(&self) -> CFDictionary

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Eq for CFDictionary

impl Debug for CFDictionary

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

Formats the value using the given formatter.