Struct CKFetchDatabaseChangesOperation 

pub struct CKFetchDatabaseChangesOperation { /* private fields */ }

Available on crate features CKDatabaseOperation and CKFetchDatabaseChangesOperation and CKOperation only.

This operation will fetch changes to record zones within a database

If a change anchor from a previous CKFetchDatabaseChangesOperationis passed in, only the zones that have changed since that anchor will be returned. This per-database serverChangeTokenis not to be confused with the per-recordZone serverChangeTokenfrom CKFetchRecordZoneChangesOperation.If this is your first fetch or if you wish to re-fetch all zones, pass nil for the change token. Change token are opaque tokens and clients should not infer any behavior based on their content. CKFetchDatabaseChangesOperationis supported in a privateCloudDatabaseand sharedCloudDatabase

See also Apple’s documentation

Implementations

impl CKFetchDatabaseChangesOperation

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

pub unsafe fn initWithPreviousServerChangeToken( this: Allocated<Self>, previous_server_change_token: Option<&CKServerChangeToken>, ) -> Retained<Self>

Available on crate feature CKServerChangeToken only.

pub unsafe fn previousServerChangeToken( &self, ) -> Option<Retained<CKServerChangeToken>>

Available on crate feature CKServerChangeToken only.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn setPreviousServerChangeToken( &self, previous_server_change_token: Option<&CKServerChangeToken>, )

Available on crate feature CKServerChangeToken only.

Setter for previousServerChangeToken.

This is copied when set.

Safety

This might not be thread-safe.

pub unsafe fn resultsLimit(&self) -> NSUInteger

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn setResultsLimit(&self, results_limit: NSUInteger)

Setter for resultsLimit.

Safety

This might not be thread-safe.

pub unsafe fn fetchAllChanges(&self) -> bool

When set to YES, this operation will send repeated requests to the server until all record zone changes have been fetched.

changeTokenUpdatedBlockwill be invoked periodically, to give clients an updated change token so that already-fetched record zone changes don’t need to be re-fetched on a subsequent operation. When set to NO, it is the responsibility of the caller to issue subsequent fetch-changes operations when moreComing is YES in a fetchDatabaseChangesCompletionBlockinvocation. fetchAllChangesis YESby default Each CKOperationinstance has a private serial queue. This queue is used for all callback block invocations Blocks assigned to this operation 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.

This property is not atomic.

Safety

This might not be thread-safe.

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

Setter for fetchAllChanges.

Safety

This might not be thread-safe.

pub unsafe fn recordZoneWithIDChangedBlock( &self, ) -> *mut DynBlock<dyn Fn(NonNull<CKRecordZoneID>)>

Available on crate features CKRecordZoneID 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.

This property is not atomic.

Safety

• The returned block’s argument must be a valid pointer.
• This might not be thread-safe.

pub unsafe fn setRecordZoneWithIDChangedBlock( &self, record_zone_with_id_changed_block: Option<&DynBlock<dyn Fn(NonNull<CKRecordZoneID>)>>, )

Available on crate features CKRecordZoneID and block2 only.

Setter for recordZoneWithIDChangedBlock.

This is copied when set.

Safety

This might not be thread-safe.

pub unsafe fn recordZoneWithIDWasDeletedBlock( &self, ) -> *mut DynBlock<dyn Fn(NonNull<CKRecordZoneID>)>

Available on crate features CKRecordZoneID 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.

This property is not atomic.

Safety

• The returned block’s argument must be a valid pointer.
• This might not be thread-safe.

pub unsafe fn setRecordZoneWithIDWasDeletedBlock( &self, record_zone_with_id_was_deleted_block: Option<&DynBlock<dyn Fn(NonNull<CKRecordZoneID>)>>, )

Available on crate features CKRecordZoneID and block2 only.

Setter for recordZoneWithIDWasDeletedBlock.

This is copied when set.

Safety

This might not be thread-safe.

pub unsafe fn recordZoneWithIDWasPurgedBlock( &self, ) -> *mut DynBlock<dyn Fn(NonNull<CKRecordZoneID>)>

Available on crate features CKRecordZoneID and block2 only.

If this block is set it will be called instead of recordZoneWithIDWasDeletedBlockif the user deleted this zone via the iCloud storage UI.

This is an indication that the user wanted all data deleted, so local cached data should be wiped and not re-uploaded to the server. 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.

This property is not atomic.

Safety

• The returned block’s argument must be a valid pointer.
• This might not be thread-safe.

pub unsafe fn setRecordZoneWithIDWasPurgedBlock( &self, record_zone_with_id_was_purged_block: Option<&DynBlock<dyn Fn(NonNull<CKRecordZoneID>)>>, )

Available on crate features CKRecordZoneID and block2 only.

Setter for recordZoneWithIDWasPurgedBlock.

This is copied when set.

Safety

This might not be thread-safe.

pub unsafe fn recordZoneWithIDWasDeletedDueToUserEncryptedDataResetBlock( &self, ) -> *mut DynBlock<dyn Fn(NonNull<CKRecordZoneID>)>

Available on crate features CKRecordZoneID and block2 only.

If this block is set it will be called instead of recordZoneWithIDWasDeletedBlockif the user chose to reset all encrypted data for their account.

This is an indication that the user had to reset encrypted data during account recovery, so local cached data should be re-uploaded to the server to minimize data loss. 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.

This property is not atomic.

Safety

• The returned block’s argument must be a valid pointer.
• This might not be thread-safe.

pub unsafe fn setRecordZoneWithIDWasDeletedDueToUserEncryptedDataResetBlock( &self, record_zone_with_id_was_deleted_due_to_user_encrypted_data_reset_block: Option<&DynBlock<dyn Fn(NonNull<CKRecordZoneID>)>>, )

Available on crate features CKRecordZoneID and block2 only.

Setter for recordZoneWithIDWasDeletedDueToUserEncryptedDataResetBlock.

This is copied when set.

Safety

This might not be thread-safe.

pub unsafe fn changeTokenUpdatedBlock( &self, ) -> *mut DynBlock<dyn Fn(NonNull<CKServerChangeToken>)>

Available on crate features CKServerChangeToken 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.

This property is not atomic.

Safety

• The returned block’s argument must be a valid pointer.
• This might not be thread-safe.

pub unsafe fn setChangeTokenUpdatedBlock( &self, change_token_updated_block: Option<&DynBlock<dyn Fn(NonNull<CKServerChangeToken>)>>, )

Available on crate features CKServerChangeToken and block2 only.

Setter for changeTokenUpdatedBlock.

This is copied when set.

Safety

This might not be thread-safe.

pub unsafe fn fetchDatabaseChangesCompletionBlock( &self, ) -> *mut DynBlock<dyn Fn(*mut CKServerChangeToken, Bool, *mut NSError)>

Available on crate features CKServerChangeToken and block2 only.

This block is called when the operation completes.

Clients are responsible for saving the change token at the end of the operation and passing it in to the next call to CKFetchDatabaseChangesOperation.If the server returns a CKErrorChangeTokenExpirederror, the previousServerChangeTokenvalue was too old and the client should toss its local cache and re-fetch the changes in this record zone starting with a nil previousServerChangeToken.If moreComingis true then the server wasn’t able to return all the changes in this response. Another CKFetchDatabaseChangesOperationoperation should be run with the previousServerChangeTokentoken from this operation. 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.

This property is not atomic.

Safety

• The returned block’s argument 1 must be a valid pointer or null.
• The returned block’s argument 3 must be a valid pointer or null.
• This might not be thread-safe.

pub unsafe fn setFetchDatabaseChangesCompletionBlock( &self, fetch_database_changes_completion_block: Option<&DynBlock<dyn Fn(*mut CKServerChangeToken, Bool, *mut NSError)>>, )

Available on crate features CKServerChangeToken and block2 only.

Setter for fetchDatabaseChangesCompletionBlock.

This is copied when set.

Safety

This might not be thread-safe.

impl CKFetchDatabaseChangesOperation

Methods declared on superclass NSObject.

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

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.

This property is not atomic.

Safety

This might not be thread-safe.

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

Available on crate feature CKDatabase only.

Setter for database.

Safety

This might not be thread-safe.

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

This property is not atomic.

Safety

This might not be thread-safe.

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

Setter for configuration.

This is copied when set.

Safety

This might not be thread-safe.

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

Available on crate feature CKOperationGroup only.

The group this operation is associated with

This property is not atomic.

Safety

This might not be thread-safe.

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

Available on crate feature CKOperationGroup only.

Setter for group.

Safety

This might not be thread-safe.

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.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn longLivedOperationWasPersistedBlock( &self, ) -> *mut DynBlock<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.

This property is not atomic.

Safety

This might not be thread-safe.

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

Available on crate feature block2 only.

Setter for longLivedOperationWasPersistedBlock.

This is copied when set.

Safety

This might not be thread-safe.

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

👎Deprecated: Use CKOperationConfiguration

Available on crate feature CKContainer only.

This property is not atomic.

Safety

This might not be thread-safe.

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

👎Deprecated: Use CKOperationConfiguration

Available on crate feature CKContainer only.

Setter for container.

Safety

This might not be thread-safe.

pub unsafe fn allowsCellularAccess(&self) -> bool

👎Deprecated: Use CKOperationConfiguration

This property is not atomic.

Safety

This might not be thread-safe.

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

👎Deprecated: Use CKOperationConfiguration

Setter for allowsCellularAccess.

Safety

This might not be thread-safe.

pub unsafe fn isLongLived(&self) -> bool

👎Deprecated: Use CKOperationConfiguration

This property is not atomic.

Safety

This might not be thread-safe.

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

👎Deprecated: Use CKOperationConfiguration

Setter for isLongLived.

Safety

This might not be thread-safe.

pub unsafe fn timeoutIntervalForRequest(&self) -> NSTimeInterval

👎Deprecated: Use CKOperationConfiguration

This property is not atomic.

Safety

This might not be thread-safe.

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

👎Deprecated: Use CKOperationConfiguration

Setter for timeoutIntervalForRequest.

Safety

This might not be thread-safe.

pub unsafe fn timeoutIntervalForResource(&self) -> NSTimeInterval

👎Deprecated: Use CKOperationConfiguration

This property is not atomic.

Safety

This might not be thread-safe.

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

👎Deprecated: Use CKOperationConfiguration

Setter for timeoutIntervalForResource.

Safety

This might not be thread-safe.

Methods from Deref<Target = NSOperation>

pub fn start(&self)

pub fn main(&self)

pub fn isCancelled(&self) -> bool

pub fn cancel(&self)

pub fn isExecuting(&self) -> bool

pub fn isFinished(&self) -> bool

pub fn isConcurrent(&self) -> bool

pub fn isAsynchronous(&self) -> bool

pub fn isReady(&self) -> bool

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

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

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

pub fn queuePriority(&self) -> NSOperationQueuePriority

pub fn setQueuePriority(&self, queue_priority: NSOperationQueuePriority)

Setter for queuePriority.

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

Safety

The returned block must be sendable.

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

Setter for completionBlock.

This is copied when set.

Safety

completion_block block must be sendable.

pub fn waitUntilFinished(&self)

pub fn threadPriority(&self) -> f64

👎Deprecated: Not supported

pub fn setThreadPriority(&self, thread_priority: f64)

👎Deprecated: Not supported

Setter for threadPriority.

pub fn qualityOfService(&self) -> NSQualityOfService

pub fn setQualityOfService(&self, quality_of_service: NSQualityOfService)

Setter for qualityOfService.

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

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

Setter for name.

This is copied when set.

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 CKFetchDatabaseChangesOperation

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CKDatabaseOperation> for CKFetchDatabaseChangesOperation

fn as_ref(&self) -> &CKDatabaseOperation

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

impl AsRef<CKFetchDatabaseChangesOperation> for CKFetchDatabaseChangesOperation

fn as_ref(&self) -> &Self

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

impl AsRef<CKOperation> for CKFetchDatabaseChangesOperation

fn as_ref(&self) -> &CKOperation

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

impl AsRef<NSObject> for CKFetchDatabaseChangesOperation

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSOperation> for CKFetchDatabaseChangesOperation

fn as_ref(&self) -> &NSOperation

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

impl Borrow<AnyObject> for CKFetchDatabaseChangesOperation

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<CKDatabaseOperation> for CKFetchDatabaseChangesOperation

fn borrow(&self) -> &CKDatabaseOperation

Immutably borrows from an owned value.

impl Borrow<CKOperation> for CKFetchDatabaseChangesOperation

fn borrow(&self) -> &CKOperation

Immutably borrows from an owned value.

impl Borrow<NSObject> for CKFetchDatabaseChangesOperation

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<NSOperation> for CKFetchDatabaseChangesOperation

fn borrow(&self) -> &NSOperation

Immutably borrows from an owned value.

impl ClassType for CKFetchDatabaseChangesOperation

const NAME: &'static str = "CKFetchDatabaseChangesOperation"

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

type Super = CKDatabaseOperation

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for CKFetchDatabaseChangesOperation

type Target = CKDatabaseOperation

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for CKFetchDatabaseChangesOperation

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 CKFetchDatabaseChangesOperation

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for CKFetchDatabaseChangesOperation

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 CKFetchDatabaseChangesOperation

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 CKFetchDatabaseChangesOperation

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

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

impl DowncastTarget for CKFetchDatabaseChangesOperation

impl Eq for CKFetchDatabaseChangesOperation