Struct CNContactFetchRequest

Source

pub struct CNContactFetchRequest { /* private fields */ }

Available on crate features CNContactFetchRequest and CNFetchRequest only.

Expand description

Specifies the search criteria to fetch contacts.

Used with [CNContactStore enumerateContactsWithFetchRequest:error:usingBlock:]. Can combine any of these options to create a contact fetch request.

Implementations§

Source §

pub unsafe fn initWithKeysToFetch( this: Allocated<Self>, keys_to_fetch: &NSArray<ProtocolObject<dyn CNKeyDescriptor>>, ) -> Retained<Self>

Available on crate feature CNContact only.

Parameter keysToFetch: The properties to fetch for the returned contacts.

Only fetch the properties that will be used.

Source

pub unsafe fn predicate(&self) -> Option<Retained<NSPredicate>>

The predicate to match contacts against.

Use only predicates from CNContact+Predicates.h. Compound predicates are not supported. Set to nil to match all contacts.

Source

pub unsafe fn setPredicate(&self, predicate: Option<&NSPredicate>)

Setter for predicate.

This is copied when set.

Source

pub unsafe fn keysToFetch( &self, ) -> Retained<NSArray<ProtocolObject<dyn CNKeyDescriptor>>>

Available on crate feature CNContact only.

The properties to fetch in the returned contacts.

Should only fetch the properties that will be used. Can combine contact keys and contact key descriptors.

Source

pub unsafe fn setKeysToFetch( &self, keys_to_fetch: &NSArray<ProtocolObject<dyn CNKeyDescriptor>>, )

Available on crate feature CNContact only.

Setter for keysToFetch.

This is copied when set.

Source

pub unsafe fn mutableObjects(&self) -> bool

To return mutable contacts.

If YES returns CNMutableContact objects, otherwise returns CNContact objects. Default is NO.

Source

pub unsafe fn setMutableObjects(&self, mutable_objects: bool)

Setter for mutableObjects.

Source

pub unsafe fn unifyResults(&self) -> bool

To return linked contacts as unified contacts.

If YES returns unified contacts, otherwise returns individual contacts. Default is YES.

Note: A unified contact is the aggregation of properties from a set of linked individual contacts. If an individual contact is not linked then the unified contact is simply that individual contact.

Source

pub unsafe fn setUnifyResults(&self, unify_results: bool)

Setter for unifyResults.

Source

pub unsafe fn sortOrder(&self) -> CNContactSortOrder

Available on crate feature CNContact only.

To return contacts in a specific sort order.

Default is CNContactSortOrderNone.

Source

pub unsafe fn setSortOrder(&self, sort_order: CNContactSortOrder)

Available on crate feature CNContact only.

Setter for sortOrder.

Methods from Deref<Target = NSObject>§

Source

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

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

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());

Source

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.

Source

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`
    }
}