Struct core_foundation::base::CFType

pub struct CFType(_);

Superclass of all Core Foundation objects.

Methods

impl CFType

pub fn downcast<T: ConcreteCFType>(&self) -> Option<T>

Try to downcast the CFType to a subclass. Checking if the instance is the correct subclass happens at runtime and None is returned if it is not the correct type. Works similar to Box::downcast and CFPropertyList::downcast.

Examples

// Create a string.
let string: CFString = CFString::from_static_string("FooBar");
// Cast it up to a CFType.
let cf_type: CFType = string.as_CFType();
// Cast it down again.
assert_eq!(cf_type.downcast::<CFString>().unwrap().to_string(), "FooBar");
// Casting it to some other type will yield `None`
assert!(cf_type.downcast::<CFBoolean>().is_none());

let boolean_array = CFArray::from_CFTypes(&[CFBoolean::true_value()]).into_CFType();

// This downcast is not allowed and causes compiler error, since it would cause undefined
// behavior to access the elements of the array as a CFString:
let invalid_string_array = boolean_array
    .downcast_into::<CFArray<CFString>>()
    .unwrap();

pub fn downcast_into<T: ConcreteCFType>(self) -> Option<T>

Similar to downcast, but consumes self and can thus avoid touching the retain count.

Trait Implementations

impl TCFType for CFType

type Ref = CFTypeRef

The reference type wrapped inside this type.

fn as_concrete_TypeRef(&self) -> CFTypeRef

Returns the object as its concrete TypeRef.

unsafe fn wrap_under_get_rule(reference: CFTypeRef) -> CFType

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(obj: CFTypeRef) -> CFType

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<CFType> for &'a CFType

fn to_void(&self) -> *const c_void

impl ToVoid<CFType> for CFType

fn to_void(&self) -> *const c_void

impl ToVoid<CFType> for CFTypeRef

fn to_void(&self) -> *const c_void

impl Drop for CFType

fn drop(&mut self)

Executes the destructor for this type.

impl PartialEq<CFType> for CFType

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

fn clone(&self) -> CFType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CFType

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

Formats the value using CFCopyDescription.