Struct NSPersistentStoreCoordinator 

pub struct NSPersistentStoreCoordinator { /* private fields */ }

Available on crate feature NSPersistentStoreCoordinator only.

Apple’s documentation

Implementations

impl NSPersistentStoreCoordinator

pub unsafe fn initWithManagedObjectModel( this: Allocated<Self>, model: &NSManagedObjectModel, ) -> Retained<Self>

Available on crate feature NSManagedObjectModel only.

pub unsafe fn managedObjectModel(&self) -> Retained<NSManagedObjectModel>

Available on crate feature NSManagedObjectModel only.

pub unsafe fn persistentStores(&self) -> Retained<NSArray<NSPersistentStore>>

Available on crate feature NSPersistentStore only.

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

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

Setter for name.

This is copied when set.

pub unsafe fn persistentStoreForURL( &self, url: &NSURL, ) -> Option<Retained<NSPersistentStore>>

Available on crate feature NSPersistentStore only.

pub unsafe fn URLForPersistentStore( &self, store: &NSPersistentStore, ) -> Retained<NSURL>

Available on crate feature NSPersistentStore only.

pub unsafe fn setURL_forPersistentStore( &self, url: &NSURL, store: &NSPersistentStore, ) -> bool

Available on crate feature NSPersistentStore only.

pub unsafe fn addPersistentStoreWithType_configuration_URL_options_error( &self, store_type: &NSString, configuration: Option<&NSString>, store_url: Option<&NSURL>, options: Option<&NSDictionary>, ) -> Result<Retained<NSPersistentStore>, Retained<NSError>>

Available on crate feature NSPersistentStore only.

Safety

options generic should be of the correct type.

pub unsafe fn addPersistentStoreWithDescription_completionHandler( &self, store_description: &NSPersistentStoreDescription, block: &DynBlock<dyn Fn(NonNull<NSPersistentStoreDescription>, *mut NSError)>, )

Available on crate features NSPersistentStoreDescription and block2 only.

pub unsafe fn removePersistentStore_error( &self, store: &NSPersistentStore, ) -> Result<(), Retained<NSError>>

Available on crate feature NSPersistentStore only.

pub unsafe fn setMetadata_forPersistentStore( &self, metadata: Option<&NSDictionary<NSString, AnyObject>>, store: &NSPersistentStore, )

Available on crate feature NSPersistentStore only.

Safety

metadata generic should be of the correct type.

pub unsafe fn metadataForPersistentStore( &self, store: &NSPersistentStore, ) -> Retained<NSDictionary<NSString, AnyObject>>

Available on crate feature NSPersistentStore only.

pub unsafe fn managedObjectIDForURIRepresentation( &self, url: &NSURL, ) -> Option<Retained<NSManagedObjectID>>

Available on crate feature NSManagedObjectID only.

pub unsafe fn executeRequest_withContext_error( &self, request: &NSPersistentStoreRequest, context: &NSManagedObjectContext, ) -> Result<Retained<AnyObject>, Retained<NSError>>

Available on crate features NSManagedObjectContext and NSPersistentStoreRequest only.

pub unsafe fn registeredStoreTypes() -> Retained<NSDictionary<NSString, NSValue>>

pub unsafe fn registerStoreClass_forStoreType( store_class: Option<&AnyClass>, store_type: &NSString, )

Safety

store_class probably has further requirements.

pub unsafe fn metadataForPersistentStoreOfType_URL_options_error( store_type: &NSString, url: &NSURL, options: Option<&NSDictionary>, ) -> Result<Retained<NSDictionary<NSString, AnyObject>>, Retained<NSError>>

Safety

options generic should be of the correct type.

pub unsafe fn setMetadata_forPersistentStoreOfType_URL_options_error( metadata: Option<&NSDictionary<NSString, AnyObject>>, store_type: &NSString, url: &NSURL, options: Option<&NSDictionary>, ) -> Result<(), Retained<NSError>>

Safety

• metadata generic should be of the correct type.
• options generic should be of the correct type.

pub unsafe fn elementsDerivedFromExternalRecordURL( file_url: &NSURL, ) -> Retained<NSDictionary>

👎Deprecated: Spotlight integration is deprecated. Use CoreSpotlight integration instead.

pub unsafe fn importStoreWithIdentifier_fromExternalRecordsDirectory_toURL_options_withType_error( &self, store_identifier: Option<&NSString>, external_records_url: &NSURL, destination_url: &NSURL, options: Option<&NSDictionary>, store_type: &NSString, ) -> Result<Retained<NSPersistentStore>, Retained<NSError>>

👎Deprecated: Spotlight integration is deprecated. Use CoreSpotlight integration instead.

Available on crate feature NSPersistentStore only.

Safety

options generic should be of the correct type.

pub unsafe fn migratePersistentStore_toURL_options_withType_error( &self, store: &NSPersistentStore, url: &NSURL, options: Option<&NSDictionary>, store_type: &NSString, ) -> Result<Retained<NSPersistentStore>, Retained<NSError>>

Available on crate feature NSPersistentStore only.

Safety

options generic should be of the correct type.

pub unsafe fn destroyPersistentStoreAtURL_withType_options_error( &self, url: &NSURL, store_type: &NSString, options: Option<&NSDictionary>, ) -> Result<(), Retained<NSError>>

Safety

options generic should be of the correct type.

pub unsafe fn replacePersistentStoreAtURL_destinationOptions_withPersistentStoreFromURL_sourceOptions_storeType_error( &self, destination_url: &NSURL, destination_options: Option<&NSDictionary>, source_url: &NSURL, source_options: Option<&NSDictionary>, store_type: &NSString, ) -> Result<(), Retained<NSError>>

Safety

• destination_options generic should be of the correct type.
• source_options generic should be of the correct type.

pub unsafe fn performBlock(&self, block: &DynBlock<dyn Fn()>)

Available on crate feature block2 only.

Safety

block block must be sendable.

pub unsafe fn performBlockAndWait(&self, block: &DynBlock<dyn Fn() + '_>)

Available on crate feature block2 only.

Safety

block block must be sendable.

pub unsafe fn currentPersistentHistoryTokenFromStores( &self, stores: Option<&NSArray>, ) -> Option<Retained<NSPersistentHistoryToken>>

Available on crate feature NSPersistentHistoryToken only.

Safety

stores generic should be of the correct type.

pub unsafe fn finishDeferredLightweightMigration( &self, ) -> Result<(), Retained<NSError>>

pub unsafe fn finishDeferredLightweightMigrationTask( &self, ) -> Result<(), Retained<NSError>>

pub unsafe fn managedObjectIDFromUTF8String_length( &self, utf8string: NonNull<c_char>, len: NSUInteger, ) -> Retained<NSManagedObjectID>

Available on crate feature NSManagedObjectID only.

Safety

utf8string must be a valid pointer.

pub unsafe fn metadataForPersistentStoreWithURL_error( url: &NSURL, ) -> Result<Retained<NSDictionary>, Retained<NSError>>

👎Deprecated: Use -metadataForPersistentStoreOfType:URL:options:error: and pass in an options dictionary matching addPersistentStoreWithType

pub unsafe fn lock(&self)

👎Deprecated: Use -performBlockAndWait: instead

pub unsafe fn unlock(&self)

👎Deprecated: Use -performBlockAndWait: instead

pub unsafe fn tryLock(&self) -> bool

👎Deprecated: Use -performBlock: instead

pub unsafe fn metadataForPersistentStoreOfType_URL_error( store_type: Option<&NSString>, url: &NSURL, ) -> Result<Retained<NSDictionary<NSString, AnyObject>>, Retained<NSError>>

👎Deprecated: Use -metadataForPersistentStoreOfType:URL:options:error: and pass in an options dictionary matching addPersistentStoreWithType

pub unsafe fn setMetadata_forPersistentStoreOfType_URL_error( metadata: Option<&NSDictionary<NSString, AnyObject>>, store_type: Option<&NSString>, url: &NSURL, ) -> Result<(), Retained<NSError>>

👎Deprecated: Use -setMetadata:forPersistentStoreOfType:URL:options:error: and pass in an options dictionary matching addPersistentStoreWithType

Safety

metadata generic should be of the correct type.

pub unsafe fn removeUbiquitousContentAndPersistentStoreAtURL_options_error( store_url: &NSURL, options: Option<&NSDictionary>, ) -> Result<(), Retained<NSError>>

👎Deprecated: Please see the release notes and Core Data documentation.

Safety

options generic should be of the correct type.

impl NSPersistentStoreCoordinator

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 NSPersistentStoreCoordinator

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for NSPersistentStoreCoordinator

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSPersistentStoreCoordinator> for NSPersistentStoreCoordinator

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for NSPersistentStoreCoordinator

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSPersistentStoreCoordinator

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for NSPersistentStoreCoordinator

const NAME: &'static str = "NSPersistentStoreCoordinator"

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

type Super = NSObject

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for NSPersistentStoreCoordinator

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NSPersistentStoreCoordinator

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 NSPersistentStoreCoordinator

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSLocking for NSPersistentStoreCoordinator

unsafe fn lock(&self)

where Self: Sized + Message,

unsafe fn unlock(&self)

where Self: Sized + Message,

impl NSObjectProtocol for NSPersistentStoreCoordinator

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 NSPersistentStoreCoordinator

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 NSPersistentStoreCoordinator

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

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

impl DowncastTarget for NSPersistentStoreCoordinator

impl Eq for NSPersistentStoreCoordinator

impl Send for NSPersistentStoreCoordinator

impl Sync for NSPersistentStoreCoordinator