Struct CKFetchRecordZoneChangesOperation

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

Available on crate features CKDatabaseOperation and CKFetchRecordZoneChangesOperation and CKOperation only.

This operation will fetch records changes across the given record zones

For each previousServerChangeTokenpassed in with a CKFetchRecordZoneChangesConfiguration,only records that have changed since that anchor will be fetched. If this is your first fetch of a zone or if you wish to re-fetch all records within a zone, do not include a previousServerChangeToken.Change tokens are opaque tokens and clients should not infer any behavior based on their content.

See also Apple’s documentation

Implementations

impl CKFetchRecordZoneChangesOperation

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

pub unsafe fn initWithRecordZoneIDs_configurationsByRecordZoneID( this: Allocated<Self>, record_zone_i_ds: &NSArray<CKRecordZoneID>, configurations_by_record_zone_id: Option<&NSDictionary<CKRecordZoneID, CKFetchRecordZoneChangesConfiguration>>, ) -> Retained<Self>

Available on crate feature CKRecordZoneID only.

pub unsafe fn recordZoneIDs(&self) -> Option<Retained<NSArray<CKRecordZoneID>>>

Available on crate feature CKRecordZoneID only.

pub unsafe fn setRecordZoneIDs( &self, record_zone_i_ds: Option<&NSArray<CKRecordZoneID>>, )

Available on crate feature CKRecordZoneID only.

Setter for recordZoneIDs.

pub unsafe fn configurationsByRecordZoneID( &self, ) -> Option<Retained<NSDictionary<CKRecordZoneID, CKFetchRecordZoneChangesConfiguration>>>

Available on crate feature CKRecordZoneID only.

pub unsafe fn setConfigurationsByRecordZoneID( &self, configurations_by_record_zone_id: Option<&NSDictionary<CKRecordZoneID, CKFetchRecordZoneChangesConfiguration>>, )

Available on crate feature CKRecordZoneID only.

Setter for configurationsByRecordZoneID.

pub unsafe fn fetchAllChanges(&self) -> bool

Determines if the operation should fetch all changes from the server before completing.

When set to YES, this operation will send repeated requests to the server until all record changes have been fetched. recordZoneChangeTokensUpdatedBlockwill be invoked periodically, to give clients an updated change token so that already-fetched record changes don’t need to be re-fetched on a subsequent operation. recordZoneFetchCompletionBlockwill only be called once and moreComingwill always be NO.

When set to NO, it is the responsibility of the caller to issue subsequent fetch-changes operations when moreComingis YES in a recordZoneFetchCompletionBlockinvocation.

fetchAllChangesis YES by default

pub unsafe fn setFetchAllChanges(&self, fetch_all_changes: bool)

Setter for fetchAllChanges.

pub unsafe fn recordChangedBlock(&self) -> *mut Block<dyn Fn(NonNull<CKRecord>)>

👎Deprecated: Use recordWasChangedBlock instead, which surfaces per-record errors

Available on crate features CKRecord and block2 only.

If the replacement callback recordWasChangedBlockis set, this callback block is ignored. Each CKOperationinstance has a private serial queue. This queue is used for all callback block invocations. This block may share mutable state with other blocks assigned to this operation, but any such mutable state should not be concurrently used outside of blocks assigned to this operation.

pub unsafe fn setRecordChangedBlock( &self, record_changed_block: Option<&Block<dyn Fn(NonNull<CKRecord>)>>, )

👎Deprecated: Use recordWasChangedBlock instead, which surfaces per-record errors

Available on crate features CKRecord and block2 only.

Setter for recordChangedBlock.

pub unsafe fn recordWasChangedBlock( &self, ) -> *mut Block<dyn Fn(NonNull<CKRecordID>, *mut CKRecord, *mut NSError)>

Available on crate features CKRecord and CKRecordID and block2 only.

If a record fails in post-processing (say, a network failure materializing a CKAssetrecord field), the per-record error will be passed here. Each CKOperationinstance has a private serial queue. This queue is used for all callback block invocations. This block may share mutable state with other blocks assigned to this operation, but any such mutable state should not be concurrently used outside of blocks assigned to this operation.

pub unsafe fn setRecordWasChangedBlock( &self, record_was_changed_block: Option<&Block<dyn Fn(NonNull<CKRecordID>, *mut CKRecord, *mut NSError)>>, )

Available on crate features CKRecord and CKRecordID and block2 only.

Setter for recordWasChangedBlock.

pub unsafe fn recordWithIDWasDeletedBlock( &self, ) -> *mut Block<dyn Fn(NonNull<CKRecordID>, NonNull<CKRecordType>)>

Available on crate features CKRecord and CKRecordID and block2 only.

Each CKOperationinstance has a private serial queue. This queue is used for all callback block invocations. This block may share mutable state with other blocks assigned to this operation, but any such mutable state should not be concurrently used outside of blocks assigned to this operation.

pub unsafe fn setRecordWithIDWasDeletedBlock( &self, record_with_id_was_deleted_block: Option<&Block<dyn Fn(NonNull<CKRecordID>, NonNull<CKRecordType>)>>, )

Available on crate features CKRecord and CKRecordID and block2 only.

Setter for recordWithIDWasDeletedBlock.

pub unsafe fn recordZoneChangeTokensUpdatedBlock( &self, ) -> *mut Block<dyn Fn(NonNull<CKRecordZoneID>, *mut CKServerChangeToken, *mut NSData)>

Available on crate features CKRecordZoneID and CKServerChangeToken and block2 only.

Clients are responsible for saving this per-recordZone serverChangeTokenand passing it in to the next call to CKFetchRecordZoneChangesOperation.Note that a fetch can fail partway. If that happens, an updated change token may be returned in this block so that already fetched records don’t need to be re-downloaded on a subsequent operation. recordZoneChangeTokensUpdatedBlockwill not be called after the last batch of changes in a zone; the recordZoneFetchCompletionBlockblock will be called instead. The clientChangeTokenDatafrom the most recent CKModifyRecordsOperationissued on this zone is also returned, or nil if none was provided. If the server returns a CKErrorChangeTokenExpirederror, the serverChangeTokenused for this record zone when initting this operation was too old and the client should toss its local cache and re-fetch the changes in this record zone starting with a nil serverChangeToken.``recordZoneChangeTokensUpdatedBlockwill not be called if fetchAllChangesis NO. Each CKOperationinstance has a private serial queue. This queue is used for all callback block invocations. This block may share mutable state with other blocks assigned to this operation, but any such mutable state should not be concurrently used outside of blocks assigned to this operation.

pub unsafe fn setRecordZoneChangeTokensUpdatedBlock( &self, record_zone_change_tokens_updated_block: Option<&Block<dyn Fn(NonNull<CKRecordZoneID>, *mut CKServerChangeToken, *mut NSData)>>, )

Available on crate features CKRecordZoneID and CKServerChangeToken and block2 only.

Setter for recordZoneChangeTokensUpdatedBlock.

pub unsafe fn recordZoneFetchCompletionBlock( &self, ) -> *mut Block<dyn Fn(NonNull<CKRecordZoneID>, *mut CKServerChangeToken, *mut NSData, Bool, *mut NSError)>

Available on crate features CKRecordZoneID and CKServerChangeToken and block2 only.

pub unsafe fn setRecordZoneFetchCompletionBlock( &self, record_zone_fetch_completion_block: Option<&Block<dyn Fn(NonNull<CKRecordZoneID>, *mut CKServerChangeToken, *mut NSData, Bool, *mut NSError)>>, )

Available on crate features CKRecordZoneID and CKServerChangeToken and block2 only.

Setter for recordZoneFetchCompletionBlock.

pub unsafe fn fetchRecordZoneChangesCompletionBlock( &self, ) -> *mut Block<dyn Fn(*mut NSError)>

Available on crate feature block2 only.

This block is called when the operation completes.

serverChangeToken-spreviously returned via a recordZoneChangeTokensUpdatedBlockor recordZoneFetchCompletionBlockinvocation, along with the record changes that preceded it, are valid even if there is a subsequent operationErrorIf the error is CKErrorPartialFailure,the error’s userInfo dictionary contains a dictionary of recordIDs and zoneIDs to errors keyed off of CKPartialErrorsByItemIDKey.Each CKOperationinstance has a private serial queue. This queue is used for all callback block invocations. This block may share mutable state with other blocks assigned to this operation, but any such mutable state should not be concurrently used outside of blocks assigned to this operation.

pub unsafe fn setFetchRecordZoneChangesCompletionBlock( &self, fetch_record_zone_changes_completion_block: Option<&Block<dyn Fn(*mut NSError)>>, )

Available on crate feature block2 only.

Setter for fetchRecordZoneChangesCompletionBlock.

impl CKFetchRecordZoneChangesOperation

Methods declared on superclass NSObject.

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

impl CKFetchRecordZoneChangesOperation

Deprecated.

pub unsafe fn initWithRecordZoneIDs_optionsByRecordZoneID( this: Allocated<Self>, record_zone_i_ds: &NSArray<CKRecordZoneID>, options_by_record_zone_id: Option<&NSDictionary<CKRecordZoneID, CKFetchRecordZoneChangesOptions>>, ) -> Retained<Self>

👎Deprecated

Available on crate feature CKRecordZoneID only.

pub unsafe fn optionsByRecordZoneID( &self, ) -> Option<Retained<NSDictionary<CKRecordZoneID, CKFetchRecordZoneChangesOptions>>>

👎Deprecated

Available on crate feature CKRecordZoneID only.

pub unsafe fn setOptionsByRecordZoneID( &self, options_by_record_zone_id: Option<&NSDictionary<CKRecordZoneID, CKFetchRecordZoneChangesOptions>>, )

👎Deprecated

Available on crate feature CKRecordZoneID only.

Setter for optionsByRecordZoneID.

Methods from Deref<Target = CKDatabaseOperation>

pub unsafe fn database(&self) -> Option<Retained<CKDatabase>>

Available on crate feature CKDatabase only.

The database on which to perform the operation.

If no database is set,

 [self.container privateCloudDatabase]

is used. This will also set the container property of the operation’s configuration to match the container of the passed-in database.

pub unsafe fn setDatabase(&self, database: Option<&CKDatabase>)

Available on crate feature CKDatabase only.

Setter for database.

Methods from Deref<Target = CKOperation>

pub unsafe fn configuration(&self) -> Retained<CKOperationConfiguration>

This defines per-operation configuration settings.

See the CKOperationConfiguration class description for info on how this configuration composes with CKOperationGroup.defaultConfiguration

pub unsafe fn setConfiguration( &self, configuration: Option<&CKOperationConfiguration>, )

Setter for configuration.

pub unsafe fn group(&self) -> Option<Retained<CKOperationGroup>>

Available on crate feature CKOperationGroup only.

The group this operation is associated with

pub unsafe fn setGroup(&self, group: Option<&CKOperationGroup>)

Available on crate feature CKOperationGroup only.

Setter for group.

pub unsafe fn operationID(&self) -> Retained<CKOperationID>

This is an identifier unique to this CKOperation.

This value is chosen by the system, and will be unique to this instance of a CKOperation. This identifier will be sent to Apple’s servers, and can be used to identify any server-side logging associated with this operation.

pub unsafe fn longLivedOperationWasPersistedBlock(&self) -> *mut Block<dyn Fn()>

Available on crate feature block2 only.

This callback is called after a long lived operation has begun running and is persisted.

Once this callback is called the operation will continue running even if the current process exits. Each CKOperationinstance has a private serial queue. This queue is used for all callback block invocations. This block may share mutable state with other blocks assigned to this operation, but any such mutable state should not be concurrently used outside of blocks assigned to this operation.

pub unsafe fn setLongLivedOperationWasPersistedBlock( &self, long_lived_operation_was_persisted_block: Option<&Block<dyn Fn()>>, )

Available on crate feature block2 only.

Setter for longLivedOperationWasPersistedBlock.

pub unsafe fn container(&self) -> Option<Retained<CKContainer>>

👎Deprecated: Use CKOperationConfiguration

Available on crate feature CKContainer only.

pub unsafe fn setContainer(&self, container: Option<&CKContainer>)

👎Deprecated: Use CKOperationConfiguration

Available on crate feature CKContainer only.

Setter for container.

pub unsafe fn allowsCellularAccess(&self) -> bool

👎Deprecated: Use CKOperationConfiguration

pub unsafe fn setAllowsCellularAccess(&self, allows_cellular_access: bool)

👎Deprecated: Use CKOperationConfiguration

Setter for allowsCellularAccess.

pub unsafe fn isLongLived(&self) -> bool

👎Deprecated: Use CKOperationConfiguration

pub unsafe fn setLongLived(&self, long_lived: bool)

👎Deprecated: Use CKOperationConfiguration

Setter for isLongLived.

pub unsafe fn timeoutIntervalForRequest(&self) -> NSTimeInterval

👎Deprecated: Use CKOperationConfiguration

pub unsafe fn setTimeoutIntervalForRequest( &self, timeout_interval_for_request: NSTimeInterval, )

👎Deprecated: Use CKOperationConfiguration

Setter for timeoutIntervalForRequest.

pub unsafe fn timeoutIntervalForResource(&self) -> NSTimeInterval

👎Deprecated: Use CKOperationConfiguration

pub unsafe fn setTimeoutIntervalForResource( &self, timeout_interval_for_resource: NSTimeInterval, )

👎Deprecated: Use CKOperationConfiguration

Setter for timeoutIntervalForResource.

Methods from Deref<Target = NSOperation>

pub unsafe fn start(&self)

pub unsafe fn main(&self)

pub unsafe fn isCancelled(&self) -> bool

pub unsafe fn cancel(&self)

pub unsafe fn isExecuting(&self) -> bool

pub unsafe fn isFinished(&self) -> bool

pub unsafe fn isConcurrent(&self) -> bool

pub unsafe fn isAsynchronous(&self) -> bool

pub unsafe fn isReady(&self) -> bool

pub unsafe fn addDependency(&self, op: &NSOperation)

pub unsafe fn removeDependency(&self, op: &NSOperation)

pub unsafe fn dependencies(&self) -> Retained<NSArray<NSOperation>>

Available on crate feature NSArray only.

pub unsafe fn queuePriority(&self) -> NSOperationQueuePriority

pub unsafe fn setQueuePriority(&self, queue_priority: NSOperationQueuePriority)

Setter for queuePriority.

pub unsafe fn completionBlock(&self) -> *mut Block<dyn Fn()>

Available on crate feature block2 only.

pub unsafe fn setCompletionBlock( &self, completion_block: Option<&Block<dyn Fn()>>, )

Available on crate feature block2 only.

Setter for completionBlock.

pub unsafe fn waitUntilFinished(&self)

pub unsafe fn threadPriority(&self) -> f64

👎Deprecated: Not supported

pub unsafe fn setThreadPriority(&self, thread_priority: f64)

👎Deprecated: Not supported

Setter for threadPriority.

pub unsafe fn qualityOfService(&self) -> NSQualityOfService

Available on crate feature NSObjCRuntime only.

pub unsafe fn setQualityOfService(&self, quality_of_service: NSQualityOfService)

Available on crate feature NSObjCRuntime only.

Setter for qualityOfService.

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

Available on crate feature NSString only.

pub unsafe fn setName(&self, name: Option<&NSString>)

Available on crate feature NSString only.

Setter for name.

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.

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 CKFetchRecordZoneChangesOperation

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CKDatabaseOperation> for CKFetchRecordZoneChangesOperation

fn as_ref(&self) -> &CKDatabaseOperation

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

impl AsRef<CKFetchRecordZoneChangesOperation> for CKFetchRecordZoneChangesOperation

fn as_ref(&self) -> &Self

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

impl AsRef<CKOperation> for CKFetchRecordZoneChangesOperation

fn as_ref(&self) -> &CKOperation

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

impl AsRef<NSObject> for CKFetchRecordZoneChangesOperation

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSOperation> for CKFetchRecordZoneChangesOperation

fn as_ref(&self) -> &NSOperation

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

impl Borrow<AnyObject> for CKFetchRecordZoneChangesOperation

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<CKDatabaseOperation> for CKFetchRecordZoneChangesOperation

fn borrow(&self) -> &CKDatabaseOperation

Immutably borrows from an owned value.

impl Borrow<CKOperation> for CKFetchRecordZoneChangesOperation

fn borrow(&self) -> &CKOperation

Immutably borrows from an owned value.

impl Borrow<NSObject> for CKFetchRecordZoneChangesOperation

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<NSOperation> for CKFetchRecordZoneChangesOperation

fn borrow(&self) -> &NSOperation

Immutably borrows from an owned value.

impl ClassType for CKFetchRecordZoneChangesOperation

const NAME: &'static str = "CKFetchRecordZoneChangesOperation"

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

type Super = CKDatabaseOperation

The superclass of this class.

type ThreadKind = <<CKFetchRecordZoneChangesOperation 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 CKFetchRecordZoneChangesOperation

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

Formats the value using the given formatter.

impl Deref for CKFetchRecordZoneChangesOperation

type Target = CKDatabaseOperation

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for CKFetchRecordZoneChangesOperation

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 CKFetchRecordZoneChangesOperation

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for CKFetchRecordZoneChangesOperation

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 CKFetchRecordZoneChangesOperation

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 CKFetchRecordZoneChangesOperation

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

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

impl DowncastTarget for CKFetchRecordZoneChangesOperation

impl Eq for CKFetchRecordZoneChangesOperation