Struct CFMutableCharacterSet

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

Available on crate feature CFCharacterSet only.

This is the type of a reference to mutable CFMutableCharacterSets.

See also Apple’s documentation

Implementations

impl CFMutableCharacterSet

pub unsafe fn new( alloc: Option<&CFAllocator>, ) -> Option<CFRetained<CFMutableCharacterSet>>

Creates a new empty mutable 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.

Returns: A reference to the new mutable CFCharacterSet.

impl CFMutableCharacterSet

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

Creates a new mutable character set with the values 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 copied. If this parameter is not a valid CFCharacterSet, the behavior is undefined.

Returns: A reference to the new mutable CFCharacterSet.

impl CFMutableCharacterSet

pub unsafe fn add_characters_in_range( the_set: Option<&CFMutableCharacterSet>, the_range: CFRange, )

Adds the given range to the charaacter set.

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

Parameter theRange: The range to add to the character set. 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.

pub unsafe fn remove_characters_in_range( the_set: Option<&CFMutableCharacterSet>, the_range: CFRange, )

Removes the given range from the charaacter set.

Parameter theSet: The character set from which the range is to be removed. If this parameter is not a valid mutable CFCharacterSet, the behavior is undefined.

Parameter theRange: The range to remove from the character set. 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.

pub unsafe fn add_characters_in_string( the_set: Option<&CFMutableCharacterSet>, the_string: Option<&CFString>, )

Adds the characters in the given string to the charaacter set.

Parameter theSet: The character set to which the characters in the string are to be added. If this parameter is not a valid mutable CFCharacterSet, the behavior is undefined.

Parameter theString: The string to add to the character set. If this parameter is not a valid CFString, the behavior is undefined.

pub unsafe fn remove_characters_in_string( the_set: Option<&CFMutableCharacterSet>, the_string: Option<&CFString>, )

Removes the characters in the given string from the charaacter set.

Parameter theSet: The character set from which the characters in the string are to be remove. If this parameter is not a valid mutable CFCharacterSet, the behavior is undefined.

Parameter theString: The string to remove from the character set. If this parameter is not a valid CFString, the behavior is undefined.

pub unsafe fn union( the_set: Option<&CFMutableCharacterSet>, the_other_set: Option<&CFCharacterSet>, )

Forms the union with the given character set.

Parameter theSet: The destination character set into which the union of the two character sets is stored. If this parameter is not a valid mutable CFCharacterSet, the behavior is undefined.

Parameter theOtherSet: The character set with which the union is formed. If this parameter is not a valid CFCharacterSet, the behavior is undefined.

pub unsafe fn intersect( the_set: Option<&CFMutableCharacterSet>, the_other_set: Option<&CFCharacterSet>, )

Forms the intersection with the given character set.

Parameter theSet: The destination character set into which the intersection of the two character sets is stored. If this parameter is not a valid mutable CFCharacterSet, the behavior is undefined.

Parameter theOtherSet: The character set with which the intersection is formed. If this parameter is not a valid CFCharacterSet, the behavior is undefined.

pub unsafe fn invert(the_set: Option<&CFMutableCharacterSet>)

Inverts the content of the given character set.

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

Methods from Deref<Target = 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.

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.

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 CFMutableCharacterSet

fn as_ref(&self) -> &AnyObject

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<CFMutableCharacterSet> for CFMutableCharacterSet

fn as_ref(&self) -> &Self

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

impl AsRef<CFType> for CFMutableCharacterSet

fn as_ref(&self) -> &CFType

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

impl Borrow<AnyObject> for CFMutableCharacterSet

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 CFMutableCharacterSet

fn borrow(&self) -> &CFType

Immutably borrows from an owned value.

impl Debug for CFMutableCharacterSet

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

Formats the value using the given formatter.

impl Deref for CFMutableCharacterSet

type Target = CFCharacterSet

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for CFMutableCharacterSet

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 CFMutableCharacterSet

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

where Self: Sized,

Increment the reference count of the receiver.

impl PartialEq for CFMutableCharacterSet

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 CFMutableCharacterSet

const ENCODING_REF: Encoding

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

impl Type for CFMutableCharacterSet

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 CFMutableCharacterSet