Struct CNContact 

pub struct CNContact { /* private fields */ }

Available on crate feature CNContact only.

An immutable value object representing a contact.

CNContact is thread safe.

If using a CNContact instance where you are not certain of the keys that were fetched, use isKeyAvailable: or areKeysAvailable:. If these return NO you need to refetch the contact by the contact identifier with the keys you want to fetch. Accessing a property that was not fetched will throw CNContactPropertyNotFetchedExceptionName.

See also Apple’s documentation

Implementations

impl CNContact

pub unsafe fn identifier(&self) -> Retained<NSString>

The identifier is unique among contacts on the device. It can be saved and used for fetching contacts next application launch.

pub unsafe fn contactType(&self) -> CNContactType

pub unsafe fn namePrefix(&self) -> Retained<NSString>

pub unsafe fn givenName(&self) -> Retained<NSString>

pub unsafe fn middleName(&self) -> Retained<NSString>

pub unsafe fn familyName(&self) -> Retained<NSString>

pub unsafe fn previousFamilyName(&self) -> Retained<NSString>

pub unsafe fn nameSuffix(&self) -> Retained<NSString>

pub unsafe fn nickname(&self) -> Retained<NSString>

pub unsafe fn organizationName(&self) -> Retained<NSString>

pub unsafe fn departmentName(&self) -> Retained<NSString>

pub unsafe fn jobTitle(&self) -> Retained<NSString>

pub unsafe fn phoneticGivenName(&self) -> Retained<NSString>

pub unsafe fn phoneticMiddleName(&self) -> Retained<NSString>

pub unsafe fn phoneticFamilyName(&self) -> Retained<NSString>

pub unsafe fn phoneticOrganizationName(&self) -> Retained<NSString>

pub unsafe fn note(&self) -> Retained<NSString>

pub unsafe fn imageData(&self) -> Option<Retained<NSData>>

pub unsafe fn thumbnailImageData(&self) -> Option<Retained<NSData>>

pub unsafe fn imageDataAvailable(&self) -> bool

pub unsafe fn phoneNumbers( &self, ) -> Retained<NSArray<CNLabeledValue<CNPhoneNumber>>>

Available on crate features CNLabeledValue and CNPhoneNumber only.

pub unsafe fn emailAddresses( &self, ) -> Retained<NSArray<CNLabeledValue<NSString>>>

Available on crate feature CNLabeledValue only.

pub unsafe fn postalAddresses( &self, ) -> Retained<NSArray<CNLabeledValue<CNPostalAddress>>>

Available on crate features CNLabeledValue and CNPostalAddress only.

pub unsafe fn urlAddresses(&self) -> Retained<NSArray<CNLabeledValue<NSString>>>

Available on crate feature CNLabeledValue only.

pub unsafe fn contactRelations( &self, ) -> Retained<NSArray<CNLabeledValue<CNContactRelation>>>

Available on crate features CNContactRelation and CNLabeledValue only.

pub unsafe fn socialProfiles( &self, ) -> Retained<NSArray<CNLabeledValue<CNSocialProfile>>>

Available on crate features CNLabeledValue and CNSocialProfile only.

pub unsafe fn instantMessageAddresses( &self, ) -> Retained<NSArray<CNLabeledValue<CNInstantMessageAddress>>>

Available on crate features CNInstantMessageAddress and CNLabeledValue only.

pub unsafe fn birthday(&self) -> Option<Retained<NSDateComponents>>

The Gregorian birthday.

pub unsafe fn nonGregorianBirthday(&self) -> Option<Retained<NSDateComponents>>

The alternate birthday (Lunisolar).

pub unsafe fn dates( &self, ) -> Retained<NSArray<CNLabeledValue<NSDateComponents>>>

Available on crate feature CNLabeledValue only.

Other Gregorian dates (anniversaries, etc).

pub unsafe fn isKeyAvailable(&self, key: &NSString) -> bool

Returns YES if the value for the specified key was fetched.

pub unsafe fn areKeysAvailable( &self, key_descriptors: &NSArray<ProtocolObject<dyn CNKeyDescriptor>>, ) -> bool

Returns YES if the values for the keys specified by all the descriptors were fetched.

pub unsafe fn localizedStringForKey(key: &NSString) -> Retained<NSString>

Returns a user displayable property name.

pub unsafe fn comparatorForNameSortOrder( sort_order: CNContactSortOrder, ) -> NSComparator

The contact comparator for a given sort order.

Safety

• The returned block’s argument 1 must be a valid pointer.
• The returned block’s argument 2 must be a valid pointer.

pub unsafe fn descriptorForAllComparatorKeys() -> Retained<ProtocolObject<dyn CNKeyDescriptor>>

Use to fetch all contact keys required for the contact sort comparator.

pub unsafe fn isUnifiedWithContactWithIdentifier( &self, contact_identifier: &NSString, ) -> bool

Returns YES if the receiver was fetched as a unified contact and includes the contact having contactIdentifier in its unification

impl CNContact

Methods declared on superclass NSObject.

pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>

pub unsafe fn new() -> Retained<Self>

impl CNContact

This impl block contains no items.

NSItemProvider.

impl CNContact

Predicates.

The predicates to match contacts against.

Can only use these predicates with CNContactStore and CNContactFetchRequest.

pub unsafe fn predicateForContactsMatchingName( name: &NSString, ) -> Retained<NSPredicate>

Available on crate feature CNContact_Predicates only.

To fetch contacts matching a name.

The name can contain any number of words.

pub unsafe fn predicateForContactsMatchingEmailAddress( email_address: &NSString, ) -> Retained<NSPredicate>

Available on crate feature CNContact_Predicates only.

Fetch contacts matching an email address.

Use this predicate to find the contact(s) which contain the specified email address. The search is not case-sensitive.

Parameter emailAddress: The email address to search for. Do not include a scheme (e.g., “mailto:”).

pub unsafe fn predicateForContactsMatchingPhoneNumber( phone_number: &CNPhoneNumber, ) -> Retained<NSPredicate>

Available on crate features CNContact_Predicates and CNPhoneNumber only.

Fetch contacts matching a phone number.

If the predicate and contact differ in their use or presence of country codes, a best effort will be made to match results; however, inexact matches are not guaranteed.

Parameter phoneNumber: A CNPhoneNumberrepresenting the phone number to search for. Do not include a scheme (e.g., “tel:”).

pub unsafe fn predicateForContactsWithIdentifiers( identifiers: &NSArray<NSString>, ) -> Retained<NSPredicate>

Available on crate feature CNContact_Predicates only.

To fetch contacts matching contact identifiers.

pub unsafe fn predicateForContactsInGroupWithIdentifier( group_identifier: &NSString, ) -> Retained<NSPredicate>

Available on crate feature CNContact_Predicates only.

pub unsafe fn predicateForContactsInContainerWithIdentifier( container_identifier: &NSString, ) -> Retained<NSPredicate>

Available on crate feature CNContact_Predicates only.

Methods from Deref<Target = NSObject>

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Use Ivar::load instead.

Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

pub fn downcast_ref<T>(&self) -> Option<&T>

where T: DowncastTarget,

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}

Trait Implementations

impl AsRef<AnyObject> for CNContact

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CNContact> for CNContact

fn as_ref(&self) -> &Self

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

impl AsRef<CNContact> for CNMutableContact

Available on crate feature CNMutableContact only.

fn as_ref(&self) -> &CNContact

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

impl AsRef<NSObject> for CNContact

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for CNContact

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<CNContact> for CNMutableContact

Available on crate feature CNMutableContact only.

fn borrow(&self) -> &CNContact

Immutably borrows from an owned value.

impl Borrow<NSObject> for CNContact

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for CNContact

const NAME: &'static str = "CNContact"

The name of the Objective-C class that this type represents.

type Super = NSObject

The superclass of this class.

type ThreadKind = <<CNContact as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread.

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl CopyingHelper for CNContact

type Result = CNContact

The immutable counterpart of the type, or Self if the type has no immutable counterpart.

impl Debug for CNContact

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

Formats the value using the given formatter.

impl Deref for CNContact

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for CNContact

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 CNContact

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

where Self: Sized,

Increment the reference count of the receiver.

impl MutableCopyingHelper for CNContact

Available on crate feature CNMutableContact only.

type Result = CNMutableContact

The mutable counterpart of the type, or Self if the type has no mutable counterpart.

impl NSCopying for CNContact

fn copy(&self) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

unsafe fn copyWithZone(&self, zone: *mut NSZone) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

impl NSItemProviderReading for CNContact

Available on crate feature CNContact_NSItemProvider only.

fn readableTypeIdentifiersForItemProvider() -> Retained<NSArray<NSString>>

where Self: Sized + ClassType,

fn objectWithItemProviderData_typeIdentifier_error( data: &NSData, type_identifier: &NSString, ) -> Result<Retained<Self>, Retained<NSError>>

where Self: Sized + ClassType,

impl NSItemProviderWriting for CNContact

Available on crate feature CNContact_NSItemProvider only.

fn writableTypeIdentifiersForItemProvider_class() -> Retained<NSArray<NSString>>

where Self: Sized + ClassType,

fn writableTypeIdentifiersForItemProvider(&self) -> Retained<NSArray<NSString>>

where Self: Sized + Message,

fn itemProviderVisibilityForRepresentationWithTypeIdentifier_class( type_identifier: &NSString, ) -> NSItemProviderRepresentationVisibility

where Self: Sized + ClassType,

fn itemProviderVisibilityForRepresentationWithTypeIdentifier( &self, type_identifier: &NSString, ) -> NSItemProviderRepresentationVisibility

where Self: Sized + Message,

impl NSMutableCopying for CNContact

fn mutableCopy(&self) -> Retained<Self::Result>

where Self: Sized + Message + MutableCopyingHelper,

Returns a new instance that’s a mutable copy of the receiver.

unsafe fn mutableCopyWithZone( &self, zone: *mut NSZone, ) -> Retained<Self::Result>

where Self: Sized + Message + MutableCopyingHelper,

Returns a new instance that’s a mutable copy of the receiver.

impl NSObjectProtocol for CNContact

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl NSSecureCoding for CNContact

fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for CNContact

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 CNContact

const ENCODING_REF: Encoding = <NSObject as ::objc2::RefEncode>::ENCODING_REF

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

impl DowncastTarget for CNContact

impl Eq for CNContact

impl NSCoding for CNContact