objc2_core_data/generated/
NSMigrationManager.rs

1//! This file has been automatically generated by `objc2`'s `header-translator`.
2//! DO NOT EDIT
3use core::ffi::*;
4use core::ptr::NonNull;
5use objc2::__framework_prelude::*;
6use objc2_foundation::*;
7
8use crate::*;
9
10extern_class!(
11    /// [Apple's documentation](https://developer.apple.com/documentation/coredata/nsmigrationmanager?language=objc)
12    #[unsafe(super(NSObject))]
13    #[derive(Debug, PartialEq, Eq, Hash)]
14    pub struct NSMigrationManager;
15);
16
17extern_conformance!(
18    unsafe impl NSObjectProtocol for NSMigrationManager {}
19);
20
21impl NSMigrationManager {
22    extern_methods!(
23        #[cfg(feature = "NSManagedObjectModel")]
24        #[unsafe(method(initWithSourceModel:destinationModel:))]
25        #[unsafe(method_family = init)]
26        pub unsafe fn initWithSourceModel_destinationModel(
27            this: Allocated<Self>,
28            source_model: &NSManagedObjectModel,
29            destination_model: &NSManagedObjectModel,
30        ) -> Retained<Self>;
31
32        #[cfg(feature = "NSMappingModel")]
33        /// # Safety
34        ///
35        /// - `s_options` generic should be of the correct type.
36        /// - `d_options` generic should be of the correct type.
37        #[unsafe(method(migrateStoreFromURL:type:options:withMappingModel:toDestinationURL:destinationType:destinationOptions:error:_))]
38        #[unsafe(method_family = none)]
39        pub unsafe fn migrateStoreFromURL_type_options_withMappingModel_toDestinationURL_destinationType_destinationOptions_error(
40            &self,
41            source_url: &NSURL,
42            s_store_type: &NSString,
43            s_options: Option<&NSDictionary>,
44            mappings: Option<&NSMappingModel>,
45            d_url: &NSURL,
46            d_store_type: &NSString,
47            d_options: Option<&NSDictionary>,
48        ) -> Result<(), Retained<NSError>>;
49
50        #[unsafe(method(usesStoreSpecificMigrationManager))]
51        #[unsafe(method_family = none)]
52        pub unsafe fn usesStoreSpecificMigrationManager(&self) -> bool;
53
54        /// Setter for [`usesStoreSpecificMigrationManager`][Self::usesStoreSpecificMigrationManager].
55        #[unsafe(method(setUsesStoreSpecificMigrationManager:))]
56        #[unsafe(method_family = none)]
57        pub unsafe fn setUsesStoreSpecificMigrationManager(
58            &self,
59            uses_store_specific_migration_manager: bool,
60        );
61
62        #[unsafe(method(reset))]
63        #[unsafe(method_family = none)]
64        pub unsafe fn reset(&self);
65
66        #[cfg(feature = "NSMappingModel")]
67        #[unsafe(method(mappingModel))]
68        #[unsafe(method_family = none)]
69        pub unsafe fn mappingModel(&self) -> Retained<NSMappingModel>;
70
71        #[cfg(feature = "NSManagedObjectModel")]
72        #[unsafe(method(sourceModel))]
73        #[unsafe(method_family = none)]
74        pub unsafe fn sourceModel(&self) -> Retained<NSManagedObjectModel>;
75
76        #[cfg(feature = "NSManagedObjectModel")]
77        #[unsafe(method(destinationModel))]
78        #[unsafe(method_family = none)]
79        pub unsafe fn destinationModel(&self) -> Retained<NSManagedObjectModel>;
80
81        #[cfg(feature = "NSManagedObjectContext")]
82        #[unsafe(method(sourceContext))]
83        #[unsafe(method_family = none)]
84        pub unsafe fn sourceContext(&self) -> Retained<NSManagedObjectContext>;
85
86        #[cfg(feature = "NSManagedObjectContext")]
87        #[unsafe(method(destinationContext))]
88        #[unsafe(method_family = none)]
89        pub unsafe fn destinationContext(&self) -> Retained<NSManagedObjectContext>;
90
91        #[cfg(all(feature = "NSEntityDescription", feature = "NSEntityMapping"))]
92        #[unsafe(method(sourceEntityForEntityMapping:))]
93        #[unsafe(method_family = none)]
94        pub unsafe fn sourceEntityForEntityMapping(
95            &self,
96            m_entity: &NSEntityMapping,
97        ) -> Option<Retained<NSEntityDescription>>;
98
99        #[cfg(all(feature = "NSEntityDescription", feature = "NSEntityMapping"))]
100        #[unsafe(method(destinationEntityForEntityMapping:))]
101        #[unsafe(method_family = none)]
102        pub unsafe fn destinationEntityForEntityMapping(
103            &self,
104            m_entity: &NSEntityMapping,
105        ) -> Option<Retained<NSEntityDescription>>;
106
107        #[cfg(all(feature = "NSEntityMapping", feature = "NSManagedObject"))]
108        #[unsafe(method(associateSourceInstance:withDestinationInstance:forEntityMapping:))]
109        #[unsafe(method_family = none)]
110        pub unsafe fn associateSourceInstance_withDestinationInstance_forEntityMapping(
111            &self,
112            source_instance: &NSManagedObject,
113            destination_instance: &NSManagedObject,
114            entity_mapping: &NSEntityMapping,
115        );
116
117        #[cfg(feature = "NSManagedObject")]
118        #[unsafe(method(destinationInstancesForEntityMappingNamed:sourceInstances:))]
119        #[unsafe(method_family = none)]
120        pub unsafe fn destinationInstancesForEntityMappingNamed_sourceInstances(
121            &self,
122            mapping_name: &NSString,
123            source_instances: Option<&NSArray<NSManagedObject>>,
124        ) -> Retained<NSArray<NSManagedObject>>;
125
126        #[cfg(feature = "NSManagedObject")]
127        #[unsafe(method(sourceInstancesForEntityMappingNamed:destinationInstances:))]
128        #[unsafe(method_family = none)]
129        pub unsafe fn sourceInstancesForEntityMappingNamed_destinationInstances(
130            &self,
131            mapping_name: &NSString,
132            destination_instances: Option<&NSArray<NSManagedObject>>,
133        ) -> Retained<NSArray<NSManagedObject>>;
134
135        #[cfg(feature = "NSEntityMapping")]
136        #[unsafe(method(currentEntityMapping))]
137        #[unsafe(method_family = none)]
138        pub unsafe fn currentEntityMapping(&self) -> Retained<NSEntityMapping>;
139
140        #[unsafe(method(migrationProgress))]
141        #[unsafe(method_family = none)]
142        pub unsafe fn migrationProgress(&self) -> c_float;
143
144        #[unsafe(method(userInfo))]
145        #[unsafe(method_family = none)]
146        pub unsafe fn userInfo(&self) -> Option<Retained<NSDictionary>>;
147
148        /// Setter for [`userInfo`][Self::userInfo].
149        ///
150        /// # Safety
151        ///
152        /// `user_info` generic should be of the correct type.
153        #[unsafe(method(setUserInfo:))]
154        #[unsafe(method_family = none)]
155        pub unsafe fn setUserInfo(&self, user_info: Option<&NSDictionary>);
156
157        #[unsafe(method(cancelMigrationWithError:))]
158        #[unsafe(method_family = none)]
159        pub unsafe fn cancelMigrationWithError(&self, error: &NSError);
160    );
161}
162
163/// Methods declared on superclass `NSObject`.
164impl NSMigrationManager {
165    extern_methods!(
166        #[unsafe(method(init))]
167        #[unsafe(method_family = init)]
168        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
169
170        #[unsafe(method(new))]
171        #[unsafe(method_family = new)]
172        pub unsafe fn new() -> Retained<Self>;
173    );
174}