Struct CFBinaryHeap 

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

Available on crate feature CFBinaryHeap only.

This is the type of a reference to CFBinaryHeaps.

See also Apple’s documentation

Implementations

impl CFBinaryHeap

pub unsafe fn new( allocator: Option<&CFAllocator>, capacity: CFIndex, call_backs: *const CFBinaryHeapCallBacks, compare_context: *const CFBinaryHeapCompareContext, ) -> Option<CFRetained<CFBinaryHeap>>

Creates a new mutable binary heap with the given values.

Parameter allocator: The CFAllocator which should be used to allocate memory for the binary heap 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 capacity: A hint about the number of values that will be held by the CFBinaryHeap. Pass 0 for no hint. The implementation may ignore this hint, or may use it to optimize various operations. A heap’s actual capacity is only limited by address space and available memory constraints). If this parameter is negative, the behavior is undefined.

Parameter callBacks: A pointer to a CFBinaryHeapCallBacks structure initialized with the callbacks for the binary heap to use on each value in the binary heap. 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 binary heap creations. If the version field of this callbacks structure is not one of the defined ones for CFBinaryHeap, the behavior is undefined. The retain field may be NULL, in which case the CFBinaryHeap will do nothing to add a retain to values as they are put into the binary heap. The release field may be NULL, in which case the CFBinaryHeap will do nothing to remove the binary heap’s retain (if any) on the values when the heap is destroyed or a key-value pair is removed. If the copyDescription field is NULL, the binary heap will create a simple description for a value. If the equal field is NULL, the binary heap 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 CFBinaryHeapCallBacks callbacks structure, the behavior is undefined. If any of the values put into the binary heap is not one understood by one of the callback functions the behavior when that callback function is used is undefined.

Parameter compareContext: A pointer to a CFBinaryHeapCompareContext structure.

Returns: A reference to the new CFBinaryHeap.

pub unsafe fn new_copy( allocator: Option<&CFAllocator>, capacity: CFIndex, heap: Option<&CFBinaryHeap>, ) -> Option<CFRetained<CFBinaryHeap>>

Creates a new mutable binary heap with the values from the given binary heap.

Parameter allocator: The CFAllocator which should be used to allocate memory for the binary heap 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 capacity: A hint about the number of values that will be held by the CFBinaryHeap. Pass 0 for no hint. The implementation may ignore this hint, or may use it to optimize various operations. A heap’s actual capacity is only limited by address space and available memory constraints). This parameter must be greater than or equal to the count of the heap which is to be copied, or the behavior is undefined. If this parameter is negative, the behavior is undefined.

Parameter heap: The binary heap which is to be copied. The values from the binary heap are copied as pointers into the new binary heap (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 binary heap. The count of the new binary will be the same as the given binary heap. The new binary heap uses the same callbacks as the binary heap to be copied. If this parameter is not a valid CFBinaryHeap, the behavior is undefined.

Returns: A reference to the new mutable binary heap.

pub unsafe fn count(self: &CFBinaryHeap) -> CFIndex

Returns the number of values currently in the binary heap.

Parameter heap: The binary heap to be queried. If this parameter is not a valid CFBinaryHeap, the behavior is undefined.

Returns: The number of values in the binary heap.

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

Counts the number of times the given value occurs in the binary heap.

Parameter heap: The binary heap to be searched. If this parameter is not a valid CFBinaryHeap, the behavior is undefined.

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

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

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

Reports whether or not the value is in the binary heap.

Parameter heap: The binary heap to be searched. If this parameter is not a valid CFBinaryHeap, the behavior is undefined.

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

Returns: true, if the value is in the specified binary heap, otherwise false.

pub unsafe fn minimum(self: &CFBinaryHeap) -> *const c_void

Returns the minimum value is in the binary heap. If the heap contains several equal minimum values, any one may be returned.

Parameter heap: The binary heap to be searched. If this parameter is not a valid CFBinaryHeap, the behavior is undefined.

Returns: A reference to the minimum value in the binary heap, or NULL if the binary heap contains no values.

pub unsafe fn minimum_if_present( self: &CFBinaryHeap, value: *mut *const c_void, ) -> bool

Returns the minimum value is in the binary heap, if present. If the heap contains several equal minimum values, any one may be returned.

Parameter heap: The binary heap to be searched. If this parameter is not a valid CFBinaryHeap, the behavior is undefined.

Parameter value: A C pointer to pointer-sized storage to be filled with the minimum value in the binary heap. If this value is not a valid C pointer to a pointer-sized block of storage, the result is undefined. If the result of the function is false, the value stored at this address is undefined.

Returns: true, if a minimum value was found in the specified binary heap, otherwise false.

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

Fills the buffer with values from the binary heap.

Parameter heap: The binary heap to be queried. If this parameter is not a valid CFBinaryHeap, the behavior is undefined.

Parameter values: A C array of pointer-sized values to be filled with values from the binary heap. The values in the C array are ordered from least to greatest. If this parameter is not a valid pointer to a C array of at least CFBinaryHeapGetCount() pointers, the behavior is undefined.

pub unsafe fn apply_function( self: &CFBinaryHeap, applier: CFBinaryHeapApplierFunction, context: *mut c_void, )

Calls a function once for each value in the binary heap.

Parameter heap: The binary heap to be operated upon. If this parameter is not a valid CFBinaryHeap, the behavior is undefined.

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

pub unsafe fn add_value(self: &CFBinaryHeap, value: *const c_void)

Adds the value to the binary heap.

Parameter heap: The binary heap to which the value is to be added. If this parameter is not a valid mutable CFBinaryHeap, the behavior is undefined.

Parameter value: The value to add to the binary heap. The value is retained by the binary heap using the retain callback provided when the binary heap was created. If the value is not of the sort expected by the retain callback, the behavior is undefined.

pub unsafe fn remove_minimum_value(self: &CFBinaryHeap)

Removes the minimum value from the binary heap.

Parameter heap: The binary heap from which the minimum value is to be removed. If this parameter is not a valid mutable CFBinaryHeap, the behavior is undefined.

pub unsafe fn remove_all_values(self: &CFBinaryHeap)

Removes all the values from the binary heap, making it empty.

Parameter heap: The binary heap from which all of the values are to be removed. If this parameter is not a valid mutable CFBinaryHeap, 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 CFBinaryHeap<T>

fn as_ref(&self) -> &AnyObject

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

impl<T: ?Sized> AsRef<CFBinaryHeap<T>> for CFBinaryHeap<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 CFBinaryHeap<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 CFBinaryHeap<T>

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

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

fn borrow(&self) -> &CFType

Immutably borrows from an owned value.

impl ConcreteType for CFBinaryHeap

fn type_id() -> CFTypeID

Returns the type identifier of all CFBinaryHeap instances.

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

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

Formats the value using the given formatter.

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

type Target = CFType

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: ?Sized> Hash for CFBinaryHeap<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 CFBinaryHeap<T>

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

where Self: Sized,

Increment the reference count of the receiver.

impl<T: ?Sized> PartialEq for CFBinaryHeap<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 CFBinaryHeap<T>

const ENCODING_REF: Encoding

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

impl<T: ?Sized> Type for CFBinaryHeap<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 CFBinaryHeap<T>