Struct CKContainer 

pub struct CKContainer { /* private fields */ }

Available on crate feature CKContainer only.

A CKContainer, and its CKDatabases, are the main entry points into the CloudKit framework.

Several methods in CloudKit accept completion handlers to indicate when they’re completed. All CKOperation subclasses include progress and completion blocks to report significant events in their lifecycles. Each of these handlers and blocks is invoked on a non-main serial queue. The receiver is responsible for handling the message on a different queue or thread if it is required.

See also Apple’s documentation

Implementations

impl CKContainer

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

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

pub unsafe fn defaultContainer() -> Retained<CKContainer>

Convenience method that uses the calling process’ “iCloud.(application-identifier)” as the container identifier

application-identifier is the calling process’ application-identifierentitlement on iOS / tvOS / watchOS. application-identifier is the calling process’ com.apple.application-identifierentitlement on macOS. On all OSes, if an com.apple.developer.associated-application-identifierentitlement is present, its value will be preferred over the application-identifiervariants.

pub unsafe fn containerWithIdentifier( container_identifier: &NSString, ) -> Retained<CKContainer>

Obtain a CKContainer for the given containerIdentifier

If the application is in production mode (aka, com.apple.developer.icloud-container-environmentis set to Production in your entitlements plist, and you have no override in com.apple.developer.icloud-container-development-container-identifiers),then the production environment is used.

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

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn addOperation(&self, operation: &CKOperation)

Available on crate feature CKOperation only.

impl CKContainer

Database.

Database properties: Records in a public database

• By default are world readable, owner writable.
• Can be locked down by Roles, a process done in the Developer Portal, a web interface. Roles are not present in the client API.
• Are visible to the application developer via the Developer Portal.
• Do not contribute to the owner’s iCloud account storage quota. Records in a private database
• By default are only owner readable and owner writable.
• Are not visible to the application developer via the Developer Portal.
• Are counted towards the owner’s iCloud account storage quota. Records in a shared database
• Are available to share participants based on the permissions of the enclosing CKShare
• Are not visible to the application developer via the Developer Portal.
• Are counted towards the originating owner’s iCloud account storage quota.

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

Available on crate feature CKDatabase only.

This property is not atomic.

Safety

This might not be thread-safe.

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

Available on crate feature CKDatabase only.

This property is not atomic.

Safety

This might not be thread-safe.

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

Available on crate feature CKDatabase only.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn databaseWithDatabaseScope( &self, database_scope: CKDatabaseScope, ) -> Retained<CKDatabase>

Available on crate feature CKDatabase only.

Convenience methods

Returns: a database that’s pointer-equal to one of the above properties

impl CKContainer

AccountStatus.

pub unsafe fn accountStatusWithCompletionHandler( &self, completion_handler: &DynBlock<dyn Fn(CKAccountStatus, *mut NSError)>, )

Available on crate feature block2 only.

Safety

completion_handler block must be sendable.

impl CKContainer

ApplicationPermission.

pub unsafe fn statusForApplicationPermission_completionHandler( &self, application_permission: CKApplicationPermissions, completion_handler: CKApplicationPermissionBlock, )

👎Deprecated: No longer supported. Please see Sharing CloudKit Data with Other iCloud Users.

Available on crate feature block2 only.

Safety

completion_handler must be a valid pointer.

pub unsafe fn requestApplicationPermission_completionHandler( &self, application_permission: CKApplicationPermissions, completion_handler: CKApplicationPermissionBlock, )

👎Deprecated: No longer supported. Please see Sharing CloudKit Data with Other iCloud Users.

Available on crate feature block2 only.

Safety

completion_handler must be a valid pointer.

impl CKContainer

UserRecords.

pub unsafe fn fetchUserRecordIDWithCompletionHandler( &self, completion_handler: &DynBlock<dyn Fn(*mut CKRecordID, *mut NSError)>, )

Available on crate features CKRecordID and block2 only.

If there is no iCloud account configured, or if access is restricted, a CKErrorNotAuthenticatederror will be returned.

This work is treated as having NSQualityOfServiceUserInitiatedquality of service.

Safety

completion_handler block must be sendable.

pub unsafe fn discoverAllIdentitiesWithCompletionHandler( &self, completion_handler: &DynBlock<dyn Fn(*mut NSArray<CKUserIdentity>, *mut NSError)>, )

👎Deprecated: No longer supported. Please see Sharing CloudKit Data with Other iCloud Users.

Available on crate features CKUserIdentity and block2 only.

Fetches all user identities that match an entry in the user’s contacts database.

CKDiscoverAllUserIdentitiesOperationis the more configurable, CKOperation-based alternative to this methods

Safety

completion_handler block must be sendable.

pub unsafe fn discoverUserIdentityWithEmailAddress_completionHandler( &self, email: &NSString, completion_handler: &DynBlock<dyn Fn(*mut CKUserIdentity, *mut NSError)>, )

👎Deprecated: No longer supported. Please see Sharing CloudKit Data with Other iCloud Users.

Available on crate features CKUserIdentity and block2 only.

Fetches the user identity that corresponds to the given email address.

Only users who have opted-in to user discoverability will have their identities returned by this method. If a user with the inputted email exists in iCloud, but has not opted-in to user discoverability, this method completes with a nil userInfo.``CKDiscoverUserIdentitiesOperationis the more configurable, CKOperation-based alternative to this method

Safety

completion_handler block must be sendable.

pub unsafe fn discoverUserIdentityWithPhoneNumber_completionHandler( &self, phone_number: &NSString, completion_handler: &DynBlock<dyn Fn(*mut CKUserIdentity, *mut NSError)>, )

👎Deprecated: No longer supported. Please see Sharing CloudKit Data with Other iCloud Users.

Available on crate features CKUserIdentity and block2 only.

Fetches the user identity that corresponds to the given phone number.

Only users who have opted-in to user discoverability will have their identities returned by this method. If a user with the inputted phone number exists in iCloud, but has not opted-in to user discoverability, this method completes with a nil userInfo.``CKDiscoverUserIdentitiesOperationis the more configurable, CKOperation-based alternative to this method

Safety

completion_handler block must be sendable.

pub unsafe fn discoverUserIdentityWithUserRecordID_completionHandler( &self, user_record_id: &CKRecordID, completion_handler: &DynBlock<dyn Fn(*mut CKUserIdentity, *mut NSError)>, )

👎Deprecated: No longer supported. Please see Sharing CloudKit Data with Other iCloud Users.

Available on crate features CKRecordID and CKUserIdentity and block2 only.

Fetches the user identity that corresponds to the given user record id.

Only users who have opted-in to user discoverability will have their identities returned by this method. If a user has not opted-in to user discoverability, this method completes with a nil userInfo.``CKDiscoverUserIdentitiesOperationis the more configurable, CKOperation-based alternative to this method

Safety

completion_handler block must be sendable.

impl CKContainer

Sharing.

pub unsafe fn fetchShareParticipantWithEmailAddress_completionHandler( &self, email_address: &NSString, completion_handler: &DynBlock<dyn Fn(*mut CKShareParticipant, *mut NSError)>, )

Available on crate features CKShareParticipant and block2 only.

Fetches share participants matching the provided info.

CKFetchShareParticipantsOperationis the more configurable, CKOperation-based alternative to these methods.

Safety

completion_handler block must be sendable.

pub unsafe fn fetchShareParticipantWithPhoneNumber_completionHandler( &self, phone_number: &NSString, completion_handler: &DynBlock<dyn Fn(*mut CKShareParticipant, *mut NSError)>, )

Available on crate features CKShareParticipant and block2 only.

Safety

completion_handler block must be sendable.

pub unsafe fn fetchShareParticipantWithUserRecordID_completionHandler( &self, user_record_id: &CKRecordID, completion_handler: &DynBlock<dyn Fn(*mut CKShareParticipant, *mut NSError)>, )

Available on crate features CKRecordID and CKShareParticipant and block2 only.

Safety

completion_handler block must be sendable.

pub unsafe fn fetchShareMetadataWithURL_completionHandler( &self, url: &NSURL, completion_handler: &DynBlock<dyn Fn(*mut CKShareMetadata, *mut NSError)>, )

Available on crate features CKShareMetadata and block2 only.

Safety

completion_handler block must be sendable.

pub unsafe fn acceptShareMetadata_completionHandler( &self, metadata: &CKShareMetadata, completion_handler: &DynBlock<dyn Fn(*mut CKShare, *mut NSError)>, )

Available on crate features CKRecord and CKShare and CKShareMetadata and block2 only.

Safety

completion_handler block must be sendable.

impl CKContainer

CKLongLivedOperations.

pub unsafe fn fetchAllLongLivedOperationIDsWithCompletionHandler( &self, completion_handler: &DynBlock<dyn Fn(*mut NSArray<CKOperationID>, *mut NSError)>, )

Available on crate features CKOperation and block2 only.

Long lived CKOperations returned by this call must be started on an operation queue. Remember to set the callback blocks before starting the operation. If an operation has already completed against the server, and is subsequently resumed, that operation will replay all of its callbacks from the start of the operation, but the request will not be re-sent to the server. If a long lived operation is cancelled or finishes completely it is no longer returned by these calls.

Safety

completion_handler block must be sendable.

pub unsafe fn fetchLongLivedOperationWithID_completionHandler( &self, operation_id: &CKOperationID, completion_handler: &DynBlock<dyn Fn(*mut CKOperation, *mut NSError)>, )

Available on crate features CKOperation and block2 only.

Safety

completion_handler block must be sendable.

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 CKContainer

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CKContainer> for CKContainer

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for CKContainer

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for CKContainer

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for CKContainer

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for CKContainer

const NAME: &'static str = "CKContainer"

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

type Super = NSObject

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for CKContainer

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for CKContainer

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 CKContainer

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for CKContainer

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 CKContainer

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 CKContainer

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

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

impl DowncastTarget for CKContainer

impl Eq for CKContainer

impl Send for CKContainer

impl Sync for CKContainer