Struct CNSaveRequest 

pub struct CNSaveRequest { /* private fields */ }

Available on crate feature CNSaveRequest only.

Specifies the changes to save.

Create a new save request for each save execution on the contact store. Can have many changes batched into one save request. Do not access objects in the save request when it is executing. A save request only applies the changes to the objects. If there are overlapping changes with multiple, concurrent CNSaveRequests then the last saved change wins.

If adding an object (contact, group, container) and it is already in the contact store then the executing save request will fail to add that object and will return the error CNErrorCodeInsertedRecordAlreadyExists with CNErrorUserInfoAffectedRecordsKey value as an array containing that object.

If updating/deleting an object (contact, group, container) and it is not in the contact store then the executing save request will fail to update/delete that object and will return the error CNErrorCodeRecordDoesNotExist with CNErrorUserInfoAffectedRecordsKey value as an array containing that object.

See also Apple’s documentation

Implementations

impl CNSaveRequest

pub unsafe fn addContact_toContainerWithIdentifier( &self, contact: &CNMutableContact, identifier: Option<&NSString>, )

Available on crate features CNContact and CNMutableContact only.

Add a new contact to the contact store.

The contact may be modified by the executing save request. If the contact was previously specified to be deleted in the save request that will no longer occur.

Parameter contact: The new contact to add.

Parameter identifier: The container identifier to add the new contact to. Set to nil for the default container.

pub unsafe fn updateContact(&self, contact: &CNMutableContact)

Available on crate features CNContact and CNMutableContact only.

Update an existing contact in the contact store.

The contact must already exist in the contact store. The contact may be modified by the executing save request.

pub unsafe fn deleteContact(&self, contact: &CNMutableContact)

Available on crate features CNContact and CNMutableContact only.

Delete a contact from the contact store.

If the contact was previously specified to be added in the save request that will no longer occur.

pub unsafe fn addGroup_toContainerWithIdentifier( &self, group: &CNMutableGroup, identifier: Option<&NSString>, )

Available on crate features CNGroup and CNMutableGroup only.

Add a new group to the contact store.

If the group was previously specified to be deleted in the save request that will no longer occur.

Parameter group: The new group to add.

Parameter identifier: The container identifier to add the new group to. Set to nil for the default container.

pub unsafe fn updateGroup(&self, group: &CNMutableGroup)

Available on crate features CNGroup and CNMutableGroup only.

Update an existing group in the contact store.

The group must already exist in the contact store.

pub unsafe fn deleteGroup(&self, group: &CNMutableGroup)

Available on crate features CNGroup and CNMutableGroup only.

Delete a group from the contact store.

The contacts in the group are not deleted. If the group was previously specified to be added in the save request that will no longer occur.

pub unsafe fn addSubgroup_toGroup(&self, subgroup: &CNGroup, group: &CNGroup)

Available on crate feature CNGroup only.

Add a new subgroup to a group.

If the subgroup was previously specified to be deleted in the save request that will no longer occur.

Parameter subgroup: The new group to add.

Parameter group: The group to add the subgroup to.

pub unsafe fn removeSubgroup_fromGroup( &self, subgroup: &CNGroup, group: &CNGroup, )

Available on crate feature CNGroup only.

Remove a subgroup from a group.

The contacts in the subgroup’s membership are not affected. If the subgroup was previously specified to be added in the save request that will no longer occur.

Parameter subgroup: The new group to add.

Parameter group: The group to add the subgroup to.

pub unsafe fn addMember_toGroup(&self, contact: &CNContact, group: &CNGroup)

Available on crate features CNContact and CNGroup only.

Add a new member to a group.

If the membership was previously specified to be deleted in the save request that will no longer occur.

Parameter contact: The new member to add to the group.

Parameter group: The group to add the member to.

pub unsafe fn removeMember_fromGroup( &self, contact: &CNContact, group: &CNGroup, )

Available on crate features CNContact and CNGroup only.

Remove a member from a group.

The contact is not deleted. It is only removed as a member of the group. If the membership was previously specified to be added in the save request that will no longer occur.

Parameter contact: The member to remove from the group.

Parameter group: The group to remove the member from.

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

The author of this transaction.

Use this, in conjunction with CNChangeHistoryFetchRequest.excludedTransactionAuthors,to suppress fetching of changes the author already knows about.

pub unsafe fn setTransactionAuthor(&self, transaction_author: Option<&NSString>)

Setter for transactionAuthor.

This is copied when set.

pub unsafe fn shouldRefetchContacts(&self) -> bool

Should the contacts be refetched as part of executing the save request.

Default is YES where added and updated contacts are refetched by the executing save request. Set to NO to suppress this refetch behavior and reduce the execution time of the save request.

Note: If set to NO do not use the contacts after the executed save request as they may not be in a current state.

pub unsafe fn setShouldRefetchContacts(&self, should_refetch_contacts: bool)

Setter for shouldRefetchContacts.

impl CNSaveRequest

Methods declared on superclass NSObject.

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

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

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 CNSaveRequest

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CNSaveRequest> for CNSaveRequest

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for CNSaveRequest

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for CNSaveRequest

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for CNSaveRequest

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for CNSaveRequest

const NAME: &'static str = "CNSaveRequest"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<CNSaveRequest 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 Debug for CNSaveRequest

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

Formats the value using the given formatter.

impl Deref for CNSaveRequest

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for CNSaveRequest

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 CNSaveRequest

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for CNSaveRequest

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 PartialEq for CNSaveRequest

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 CNSaveRequest

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

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

impl DowncastTarget for CNSaveRequest

impl Eq for CNSaveRequest