Struct CFCharacterSet 

#[repr(C)]
pub struct CFCharacterSet { /* private fields */ }

Available on crate feature CFCharacterSet only.

This is the type of a reference to immutable CFCharacterSets.

See also Apple’s documentation

Implementations

impl CFCharacterSet

pub unsafe fn predefined( the_set_identifier: CFCharacterSetPredefinedSet, ) -> Option<CFRetained<CFCharacterSet>>

Returns a predefined CFCharacterSet instance.

Parameter theSetIdentifier: The CFCharacterSetPredefinedSet selector which specifies the predefined character set. If the value is not in CFCharacterSetPredefinedSet, the behavior is undefined.

Returns: A reference to the predefined immutable CFCharacterSet. This instance is owned by CF.

pub unsafe fn with_characters_in_range( alloc: Option<&CFAllocator>, the_range: CFRange, ) -> Option<CFRetained<CFCharacterSet>>

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

Parameter alloc: The CFAllocator which should be used to allocate memory for the array 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 theRange: The CFRange which should be used to specify the Unicode range the character set is filled with. It accepts the range in 32-bit in the UTF-32 format. The valid character point range is from 0x00000 to 0x10FFFF. If the range is outside of the valid Unicode character point, the behavior is undefined.

Returns: A reference to the new immutable CFCharacterSet.

pub unsafe fn with_characters_in_string( alloc: Option<&CFAllocator>, the_string: Option<&CFString>, ) -> Option<CFRetained<CFCharacterSet>>

Creates a new immutable character set with the values in the given string.

Parameter alloc: The CFAllocator which should be used to allocate memory for the array 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 theString: The CFString which should be used to specify the Unicode characters the character set is filled with. If this parameter is not a valid CFString, the behavior is undefined.

Returns: A reference to the new immutable CFCharacterSet.

pub unsafe fn with_bitmap_representation( alloc: Option<&CFAllocator>, the_data: Option<&CFData>, ) -> Option<CFRetained<CFCharacterSet>>

Available on crate feature CFData only.

Creates a new immutable character set with the bitmap representtion in the given data.

Parameter alloc: The CFAllocator which should be used to allocate memory for the array 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 theData: The CFData which should be used to specify the bitmap representation of the Unicode character points the character set is filled with. The bitmap representation could contain all the Unicode character range starting from BMP to Plane 16. The first 8192 bytes of the data represent the BMP range. The BMP range 8192 bytes can be followed by zero to sixteen 8192 byte bitmaps, each one with the plane index byte prepended. For example, the bitmap representing the BMP and Plane 2 has the size of 16385 bytes (8192 bytes for BMP, 1 byte index + 8192 bytes bitmap for Plane 2). The plane index byte, in this case, contains the integer value two. If this parameter is not a valid CFData or it contains a Plane index byte outside of the valid Plane range (1 to 16), the behavior is undefined.

Returns: A reference to the new immutable CFCharacterSet.

pub unsafe fn new_inverted_set( alloc: Option<&CFAllocator>, the_set: Option<&CFCharacterSet>, ) -> Option<CFRetained<CFCharacterSet>>

Creates a new immutable character set that is the invert of the specified character set.

Parameter alloc: The CFAllocator which should be used to allocate memory for the array 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 CFCharacterSet which is to be inverted. If this parameter is not a valid CFCharacterSet, the behavior is undefined.

Returns: A reference to the new immutable CFCharacterSet.

pub unsafe fn is_superset_of_set( self: &CFCharacterSet, the_otherset: Option<&CFCharacterSet>, ) -> bool

Reports whether or not the character set is a superset of the character set specified as the second parameter.

Parameter theSet: The character set to be checked for the membership of theOtherSet. If this parameter is not a valid CFCharacterSet, the behavior is undefined.

Parameter theOtherset: The character set to be checked whether or not it is a subset of theSet. If this parameter is not a valid CFCharacterSet, the behavior is undefined.

pub unsafe fn has_member_in_plane( self: &CFCharacterSet, the_plane: CFIndex, ) -> bool

Reports whether or not the character set contains at least one member character in the specified plane.

Parameter theSet: The character set to be checked for the membership. If this parameter is not a valid CFCharacterSet, the behavior is undefined.

Parameter thePlane: The plane number to be checked for the membership. The valid value range is from 0 to 16. If the value is outside of the valid plane number range, the behavior is undefined.

impl CFCharacterSet

pub unsafe fn new_copy( alloc: Option<&CFAllocator>, the_set: Option<&CFCharacterSet>, ) -> Option<CFRetained<CFCharacterSet>>

Creates a new character set with the values from the given character set. This function tries to compact the backing store where applicable.

Parameter alloc: The CFAllocator which should be used to allocate memory for the array 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 CFCharacterSet which is to be copied. If this parameter is not a valid CFCharacterSet, the behavior is undefined.

Returns: A reference to the new CFCharacterSet.

impl CFCharacterSet

pub unsafe fn is_character_member(self: &CFCharacterSet, the_char: u16) -> bool

Reports whether or not the Unicode character is in the character set.

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

Parameter theChar: The Unicode character for which to test against the character set. Note that this function takes 16-bit Unicode character value; hence, it does not support access to the non-BMP planes.

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

pub unsafe fn is_long_character_member( self: &CFCharacterSet, the_char: u32, ) -> bool

Reports whether or not the UTF-32 character is in the character set.

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

Parameter theChar: The UTF-32 character for which to test against the character set.

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

pub unsafe fn new_bitmap_representation( alloc: Option<&CFAllocator>, the_set: Option<&CFCharacterSet>, ) -> Option<CFRetained<CFData>>

Available on crate feature CFData only.

Creates a new immutable data with the bitmap representation from the given character set.

Parameter alloc: The CFAllocator which should be used to allocate memory for the array 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 CFCharacterSet which is to be used create the bitmap representation from. Refer to the comments for CFCharacterSetCreateWithBitmapRepresentation for the detailed discussion of the bitmap representation format. If this parameter is not a valid CFCharacterSet, the behavior is undefined.

Returns: A reference to the new immutable CFData.

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 AsRef<AnyObject> for CFCharacterSet

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CFCharacterSet> for CFCharacterSet

fn as_ref(&self) -> &Self

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

impl AsRef<CFCharacterSet> for CFMutableCharacterSet

fn as_ref(&self) -> &CFCharacterSet

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

impl AsRef<CFType> for CFCharacterSet

fn as_ref(&self) -> &CFType

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

impl Borrow<AnyObject> for CFCharacterSet

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<CFCharacterSet> for CFMutableCharacterSet

fn borrow(&self) -> &CFCharacterSet

Immutably borrows from an owned value.

impl Borrow<CFType> for CFCharacterSet

fn borrow(&self) -> &CFType

Immutably borrows from an owned value.

impl ConcreteType for CFCharacterSet

fn type_id() -> CFTypeID

Returns the type identifier of all CFCharacterSet instances.

impl Debug for CFCharacterSet

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

Formats the value using the given formatter.

impl Deref for CFCharacterSet

type Target = CFType

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for CFCharacterSet

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 Message for CFCharacterSet

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

where Self: Sized,

Increment the reference count of the receiver.

impl PartialEq for CFCharacterSet

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 RefEncode for CFCharacterSet

const ENCODING_REF: Encoding

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

impl Type for CFCharacterSet

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 Eq for CFCharacterSet