Trait core_foundation::base::TCFType

pub trait TCFType {
    type Ref: TCFTypeRef;
    fn as_concrete_TypeRef(&self) -> Self::Ref;
    unsafe fn wrap_under_create_rule(obj: Self::Ref) -> Self;
    fn type_id() -> CFTypeID;
    fn as_CFTypeRef(&self) -> CFTypeRef;
    unsafe fn wrap_under_get_rule(reference: Self::Ref) -> Self;

    fn as_CFType(&self) -> CFType { ... }
    fn into_CFType(self) -> CFType
    where
        Self: Sized,
    { ... }
    fn retain_count(&self) -> CFIndex { ... }
    fn type_of(&self) -> CFTypeID { ... }
    fn show(&self) { ... }
    fn instance_of<OtherCFType: TCFType>(&self) -> bool { ... }
}

All Core Foundation types implement this trait. The associated type Ref specifies the associated Core Foundation type: e.g. for CFType this is CFTypeRef; for CFArray this is CFArrayRef.

Most structs that implement this trait will do so via the impl_TCFType macro.

Associated Types

type Ref: TCFTypeRef

The reference type wrapped inside this type.

Required methods

fn as_concrete_TypeRef(&self) -> Self::Ref

Returns the object as its concrete TypeRef.

unsafe fn wrap_under_create_rule(obj: Self::Ref) -> 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_CFTypeRef(&self) -> CFTypeRef

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

unsafe fn wrap_under_get_rule(reference: Self::Ref) -> 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.

Provided methods

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.

Implementors

impl TCFType for CFAttributedString

type Ref = CFAttributedStringRef

fn as_concrete_TypeRef(&self) -> CFAttributedStringRef

unsafe fn wrap_under_get_rule(reference: CFAttributedStringRef) -> Self

fn as_CFTypeRef(&self) -> CFTypeRef

unsafe fn wrap_under_create_rule(reference: CFAttributedStringRef) -> Self

fn type_id() -> CFTypeID

impl TCFType for CFMutableAttributedString

type Ref = CFMutableAttributedStringRef

fn as_concrete_TypeRef(&self) -> CFMutableAttributedStringRef

unsafe fn wrap_under_get_rule(reference: CFMutableAttributedStringRef) -> Self

fn as_CFTypeRef(&self) -> CFTypeRef

unsafe fn wrap_under_create_rule(
    reference: CFMutableAttributedStringRef
) -> Self

fn type_id() -> CFTypeID

impl TCFType for CFBoolean

type Ref = CFBooleanRef

fn as_concrete_TypeRef(&self) -> CFBooleanRef

unsafe fn wrap_under_get_rule(reference: CFBooleanRef) -> Self

fn as_CFTypeRef(&self) -> CFTypeRef

unsafe fn wrap_under_create_rule(reference: CFBooleanRef) -> Self

fn type_id() -> CFTypeID

impl TCFType for CFBundle

type Ref = CFBundleRef

fn as_concrete_TypeRef(&self) -> CFBundleRef

unsafe fn wrap_under_get_rule(reference: CFBundleRef) -> Self

fn as_CFTypeRef(&self) -> CFTypeRef

unsafe fn wrap_under_create_rule(reference: CFBundleRef) -> Self

fn type_id() -> CFTypeID

impl TCFType for CFData

type Ref = CFDataRef

fn as_concrete_TypeRef(&self) -> CFDataRef

unsafe fn wrap_under_get_rule(reference: CFDataRef) -> Self

fn as_CFTypeRef(&self) -> CFTypeRef

unsafe fn wrap_under_create_rule(reference: CFDataRef) -> Self

fn type_id() -> CFTypeID

impl TCFType for CFDate

type Ref = CFDateRef

fn as_concrete_TypeRef(&self) -> CFDateRef

unsafe fn wrap_under_get_rule(reference: CFDateRef) -> Self

fn as_CFTypeRef(&self) -> CFTypeRef

unsafe fn wrap_under_create_rule(reference: CFDateRef) -> Self

fn type_id() -> CFTypeID

impl TCFType for CFError

type Ref = CFErrorRef

fn as_concrete_TypeRef(&self) -> CFErrorRef

unsafe fn wrap_under_get_rule(reference: CFErrorRef) -> Self

fn as_CFTypeRef(&self) -> CFTypeRef

unsafe fn wrap_under_create_rule(reference: CFErrorRef) -> Self

fn type_id() -> CFTypeID

impl TCFType for CFFileDescriptor

type Ref = CFFileDescriptorRef

fn as_concrete_TypeRef(&self) -> CFFileDescriptorRef

unsafe fn wrap_under_get_rule(reference: CFFileDescriptorRef) -> Self

fn as_CFTypeRef(&self) -> CFTypeRef

unsafe fn wrap_under_create_rule(reference: CFFileDescriptorRef) -> Self

fn type_id() -> CFTypeID

impl TCFType for CFNumber

type Ref = CFNumberRef

fn as_concrete_TypeRef(&self) -> CFNumberRef

unsafe fn wrap_under_get_rule(reference: CFNumberRef) -> Self

fn as_CFTypeRef(&self) -> CFTypeRef

unsafe fn wrap_under_create_rule(reference: CFNumberRef) -> Self

fn type_id() -> CFTypeID

impl TCFType for CFRunLoop

type Ref = CFRunLoopRef

fn as_concrete_TypeRef(&self) -> CFRunLoopRef

unsafe fn wrap_under_get_rule(reference: CFRunLoopRef) -> Self

fn as_CFTypeRef(&self) -> CFTypeRef

unsafe fn wrap_under_create_rule(reference: CFRunLoopRef) -> Self

fn type_id() -> CFTypeID

impl TCFType for CFRunLoopObserver

type Ref = CFRunLoopObserverRef

fn as_concrete_TypeRef(&self) -> CFRunLoopObserverRef

unsafe fn wrap_under_get_rule(reference: CFRunLoopObserverRef) -> Self

fn as_CFTypeRef(&self) -> CFTypeRef

unsafe fn wrap_under_create_rule(reference: CFRunLoopObserverRef) -> Self

fn type_id() -> CFTypeID

impl TCFType for CFRunLoopSource

type Ref = CFRunLoopSourceRef

fn as_concrete_TypeRef(&self) -> CFRunLoopSourceRef

unsafe fn wrap_under_get_rule(reference: CFRunLoopSourceRef) -> Self

fn as_CFTypeRef(&self) -> CFTypeRef

unsafe fn wrap_under_create_rule(reference: CFRunLoopSourceRef) -> Self

fn type_id() -> CFTypeID

impl TCFType for CFRunLoopTimer

type Ref = CFRunLoopTimerRef

fn as_concrete_TypeRef(&self) -> CFRunLoopTimerRef

unsafe fn wrap_under_get_rule(reference: CFRunLoopTimerRef) -> Self

fn as_CFTypeRef(&self) -> CFTypeRef

unsafe fn wrap_under_create_rule(reference: CFRunLoopTimerRef) -> Self

fn type_id() -> CFTypeID

impl TCFType for CFString

type Ref = CFStringRef

fn as_concrete_TypeRef(&self) -> CFStringRef

unsafe fn wrap_under_get_rule(reference: CFStringRef) -> Self

fn as_CFTypeRef(&self) -> CFTypeRef

unsafe fn wrap_under_create_rule(reference: CFStringRef) -> Self

fn type_id() -> CFTypeID

impl TCFType for CFTimeZone

type Ref = CFTimeZoneRef

fn as_concrete_TypeRef(&self) -> CFTimeZoneRef

unsafe fn wrap_under_get_rule(reference: CFTimeZoneRef) -> Self

fn as_CFTypeRef(&self) -> CFTypeRef

unsafe fn wrap_under_create_rule(reference: CFTimeZoneRef) -> Self

fn type_id() -> CFTypeID

impl TCFType for CFURL

type Ref = CFURLRef

fn as_concrete_TypeRef(&self) -> CFURLRef

unsafe fn wrap_under_get_rule(reference: CFURLRef) -> Self

fn as_CFTypeRef(&self) -> CFTypeRef

unsafe fn wrap_under_create_rule(reference: CFURLRef) -> Self

fn type_id() -> CFTypeID

impl TCFType for CFUUID

type Ref = CFUUIDRef

fn as_concrete_TypeRef(&self) -> CFUUIDRef

unsafe fn wrap_under_get_rule(reference: CFUUIDRef) -> Self

fn as_CFTypeRef(&self) -> CFTypeRef

unsafe fn wrap_under_create_rule(reference: CFUUIDRef) -> Self

fn type_id() -> CFTypeID

impl TCFType for CFAllocator

type Ref = CFAllocatorRef

fn as_concrete_TypeRef(&self) -> CFAllocatorRef

unsafe fn wrap_under_get_rule(reference: CFAllocatorRef) -> Self

fn as_CFTypeRef(&self) -> CFTypeRef

unsafe fn wrap_under_create_rule(reference: CFAllocatorRef) -> Self

fn type_id() -> CFTypeID

impl TCFType for CFType

type Ref = CFTypeRef

fn as_concrete_TypeRef(&self) -> CFTypeRef

unsafe fn wrap_under_get_rule(reference: CFTypeRef) -> CFType

fn as_CFTypeRef(&self) -> CFTypeRef

unsafe fn wrap_under_create_rule(obj: CFTypeRef) -> CFType

fn type_id() -> CFTypeID

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

type Ref = CFDictionaryRef

fn as_concrete_TypeRef(&self) -> CFDictionaryRef

unsafe fn wrap_under_get_rule(reference: CFDictionaryRef) -> Self

fn as_CFTypeRef(&self) -> CFTypeRef

unsafe fn wrap_under_create_rule(reference: CFDictionaryRef) -> Self

fn type_id() -> CFTypeID

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

type Ref = CFMutableDictionaryRef

fn as_concrete_TypeRef(&self) -> CFMutableDictionaryRef

unsafe fn wrap_under_get_rule(reference: CFMutableDictionaryRef) -> Self

fn as_CFTypeRef(&self) -> CFTypeRef

unsafe fn wrap_under_create_rule(reference: CFMutableDictionaryRef) -> Self

fn type_id() -> CFTypeID

impl<T> TCFType for CFArray<T>

type Ref = CFArrayRef

fn as_concrete_TypeRef(&self) -> CFArrayRef

unsafe fn wrap_under_get_rule(reference: CFArrayRef) -> Self

fn as_CFTypeRef(&self) -> CFTypeRef

unsafe fn wrap_under_create_rule(reference: CFArrayRef) -> Self

fn type_id() -> CFTypeID

impl<T> TCFType for CFSet<T>

type Ref = CFSetRef

fn as_concrete_TypeRef(&self) -> CFSetRef

unsafe fn wrap_under_get_rule(reference: CFSetRef) -> Self

fn as_CFTypeRef(&self) -> CFTypeRef

unsafe fn wrap_under_create_rule(reference: CFSetRef) -> Self

fn type_id() -> CFTypeID