Struct CFSet 

#[repr(C)]
pub struct CFSet<T: ?Sized = Opaque> { /* private fields */ }

Available on crate feature CFSet only.

This is the type of a reference to immutable CFSets.

See also Apple’s documentation

Implementations

impl CFSet

pub unsafe fn new( allocator: Option<&CFAllocator>, values: *mut *const c_void, num_values: CFIndex, call_backs: *const CFSetCallBacks, ) -> Option<CFRetained<CFSet>>

Creates a new immutable set with the given values.

Parameter allocator: The CFAllocator which should be used to allocate memory for the set 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 values: A C array of the pointer-sized values to be in the set. 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 values C array into the CFSet. This number will be the count of the set. If this parameter is zero, negative, or greater than the number of values actually in the values C array, the behavior is undefined.

Parameter callBacks: A C pointer to a CFSetCallBacks structure initialized with the callbacks for the set to use on each value in the set. 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 set creations. If the version field of this callbacks structure is not one of the defined ones for CFSet, the behavior is undefined. The retain field may be NULL, in which case the CFSet will do nothing to add a retain to the contained values for the set. The release field may be NULL, in which case the CFSet will do nothing to remove the set’s retain (if any) on the values when the set is destroyed. If the copyDescription field is NULL, the set will create a simple description for the value. If the equal field is NULL, the set will use pointer equality to test for equality of values. The hash field may be NULL, in which case the CFSet will determine uniqueness by pointer equality. 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 CFSetCallBacks callbacks structure, the behavior is undefined. If any of the values put into the set 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 CFSet.

pub fn new_copy( allocator: Option<&CFAllocator>, the_set: Option<&CFSet>, ) -> Option<CFRetained<CFSet>>

Creates a new immutable set with the values from the given set.

Parameter allocator: The CFAllocator which should be used to allocate memory for the set 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 theSet: The set which is to be copied. The values from the set are copied as pointers into the new set (that is, the values themselves are copied, not that which the values point to, if anything). However, the values are also retained by the new set. The count of the new set will be the same as the copied set. The new set uses the same callbacks as the set to be copied. If this parameter is not a valid CFSet, the behavior is undefined.

Returns: A reference to the new immutable CFSet.

impl CFSet

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

Returns the number of values currently in the set.

Parameter theSet: The set to be queried. If this parameter is not a valid CFSet, the behavior is undefined.

Returns: The number of values in the set.

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

Counts the number of times the given value occurs in the set. Since sets by definition contain only one instance of a value, this function is synonymous to CFSetContainsValue.

Parameter theSet: The set to be searched. If this parameter is not a valid CFSet, the behavior is undefined.

Parameter value: The value for which to find matches in the set. The equal() callback provided when the set 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 set, are not understood by the equal() callback, the behavior is undefined.

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

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

Reports whether or not the value is in the set.

Parameter theSet: The set to be searched. If this parameter is not a valid CFSet, the behavior is undefined.

Parameter value: The value for which to find matches in the set. The equal() callback provided when the set 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 set, are not understood by the equal() callback, the behavior is undefined.

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

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

Retrieves a value in the set which hashes the same as the specified value.

Parameter theSet: The set to be queried. If this parameter is not a valid CFSet, the behavior is undefined.

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

Returns: The value in the set with the given hash.

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

Retrieves a value in the set which hashes the same as the specified value, if present.

Parameter theSet: The set to be queried. If this parameter is not a valid CFSet, the behavior is undefined.

Parameter candidate: This value is hashed and compared with values in the set to determine which value to retrieve. The equal() callback provided when the set was created is used to compare. If the equal() callback was NULL, pointer equality (in C, ==) is used. If a value, or any of the values in the set, 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 value is found. If no 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 value was present).

Returns: True if the value was present in the set, otherwise false.

pub unsafe fn values(self: &CFSet, values: *mut *const c_void)

Fills the buffer with values from the set.

Parameter theSet: The set to be queried. If this parameter is not a valid CFSet, the behavior is undefined.

Parameter values: A C array of pointer-sized values to be filled with values from the set. The values in the C array are ordered in the same order in which they appear in the set. If this parameter is not a valid pointer to a C array of at least CFSetGetCount() pointers, the behavior is undefined.

pub unsafe fn apply_function( self: &CFSet, applier: CFSetApplierFunction, context: *mut c_void, )

Calls a function once for each value in the set.

Parameter theSet: The set to be operated upon. If this parameter is not a valid CFSet, the behavior is undefined.

Parameter applier: The callback function to call once for each value in the given set. If this parameter is not a pointer to a function of the correct prototype, the behavior is undefined. If there are values in the set 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 second 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<T: ?Sized> AsRef<AnyObject> for CFSet<T>

fn as_ref(&self) -> &AnyObject

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

impl<T: ?Sized> AsRef<CFSet<T>> for CFMutableSet<T>

fn as_ref(&self) -> &CFSet<T>

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

impl<T: ?Sized> AsRef<CFSet<T>> for CFSet<T>

fn as_ref(&self) -> &Self

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

impl<T: ?Sized> AsRef<CFType> for CFSet<T>

fn as_ref(&self) -> &CFType

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

impl<T: ?Sized> Borrow<AnyObject> for CFSet<T>

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl<T: ?Sized> Borrow<CFSet<T>> for CFMutableSet<T>

fn borrow(&self) -> &CFSet<T>

Immutably borrows from an owned value.

impl<T: ?Sized> Borrow<CFType> for CFSet<T>

fn borrow(&self) -> &CFType

Immutably borrows from an owned value.

impl ConcreteType for CFSet

fn type_id() -> CFTypeID

Returns the type identifier of all CFSet instances.

impl<T: ?Sized> Debug for CFSet<T>

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

Formats the value using the given formatter.

impl<T: ?Sized> Deref for CFSet<T>

type Target = CFType

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: ?Sized> Hash for CFSet<T>

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<T: ?Sized> Message for CFSet<T>

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

where Self: Sized,

Increment the reference count of the receiver.

impl<T: ?Sized> PartialEq for CFSet<T>

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<T: ?Sized> RefEncode for CFSet<T>

const ENCODING_REF: Encoding

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

impl<T: ?Sized> Type for CFSet<T>

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<T: ?Sized> Eq for CFSet<T>