Struct core_foundation::array::CFArray

pub struct CFArray<T = *const c_void>(_, _);

A heterogeneous immutable array.

Methods

impl<T> CFArray<T>

pub fn from_copyable(elems: &[T]) -> CFArray<T> where
    T: Copy, 

Creates a new CFArray with the given elements, which must implement Copy.

pub fn from_CFTypes(elems: &[T]) -> CFArray<T> where
    T: TCFType, 

Creates a new CFArray with the given elements, which must be CFType objects.

pub fn to_untyped(&self) -> CFArray

pub fn into_untyped(self) -> CFArray

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

Important traits for CFArrayIterator<'a, T>

impl<'a, T: FromVoid> Iterator for CFArrayIterator<'a, T> type Item = ItemRef<'a, T>;

pub fn iter<'a>(&'a self) -> CFArrayIterator<'a, T>

Iterates over the elements of this CFArray.

Careful; the loop body must wrap the reference properly. Generally, when array elements are Core Foundation objects (not always true), they need to be wrapped with TCFType::wrap_under_get_rule().

pub fn len(&self) -> CFIndex

pub unsafe fn get_unchecked<'a>(&'a self, index: CFIndex) -> ItemRef<'a, T> where
    T: FromVoid, 

pub fn get<'a>(&'a self, index: CFIndex) -> Option<ItemRef<'a, T>> where
    T: FromVoid, 

pub fn get_values(&self, range: CFRange) -> Vec<*const c_void>

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

Trait Implementations

impl ConcreteCFType for CFArray<*const c_void>

impl<T> TCFType for CFArray<T>

type Ref = CFArrayRef

The reference type wrapped inside this type.

fn as_concrete_TypeRef(&self) -> CFArrayRef

Returns the object as its concrete TypeRef.

unsafe fn wrap_under_get_rule(reference: CFArrayRef) -> 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: CFArrayRef) -> 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<CFArray<*const c_void>> for &'a CFArray

fn to_void(&self) -> *const c_void

impl ToVoid<CFArray<*const c_void>> for CFArray

fn to_void(&self) -> *const c_void

impl ToVoid<CFArray<*const c_void>> for CFArrayRef

fn to_void(&self) -> *const c_void

impl CFPropertyListSubClass for CFArray

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<T> Drop for CFArray<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a, T: FromVoid> IntoIterator for &'a CFArray<T>

type Item = ItemRef<'a, T>

The type of the elements being iterated over.

type IntoIter = CFArrayIterator<'a, T>

Which kind of iterator are we turning this into?

Important traits for CFArrayIterator<'a, T>

impl<'a, T: FromVoid> Iterator for CFArrayIterator<'a, T> type Item = ItemRef<'a, T>;

fn into_iter(self) -> CFArrayIterator<'a, T>

Creates an iterator from a value.

impl Eq for CFArray

impl PartialEq<CFArray<*const c_void>> for CFArray

fn eq(&self, other: &CFArray) -> 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 Clone for CFArray

fn clone(&self) -> CFArray

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CFArray

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

Formats the value using the given formatter.