objc2-core-data 0.3.2

Bindings to the CoreData framework
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174

//! This file has been automatically generated by `objc2`'s `header-translator`.
//! DO NOT EDIT
use core::ffi::*;
use core::ptr::NonNull;
use objc2::__framework_prelude::*;
use objc2_foundation::*;

use crate::*;

extern_class!(
    /// [Apple's documentation](https://developer.apple.com/documentation/coredata/nsmigrationmanager?language=objc)
    #[unsafe(super(NSObject))]
    #[derive(Debug, PartialEq, Eq, Hash)]
    pub struct NSMigrationManager;
);

extern_conformance!(
    unsafe impl NSObjectProtocol for NSMigrationManager {}
);

impl NSMigrationManager {
    extern_methods!(
        #[cfg(feature = "NSManagedObjectModel")]
        #[unsafe(method(initWithSourceModel:destinationModel:))]
        #[unsafe(method_family = init)]
        pub unsafe fn initWithSourceModel_destinationModel(
            this: Allocated<Self>,
            source_model: &NSManagedObjectModel,
            destination_model: &NSManagedObjectModel,
        ) -> Retained<Self>;

        #[cfg(feature = "NSMappingModel")]
        /// # Safety
        ///
        /// - `s_options` generic should be of the correct type.
        /// - `d_options` generic should be of the correct type.
        #[unsafe(method(migrateStoreFromURL:type:options:withMappingModel:toDestinationURL:destinationType:destinationOptions:error:_))]
        #[unsafe(method_family = none)]
        pub unsafe fn migrateStoreFromURL_type_options_withMappingModel_toDestinationURL_destinationType_destinationOptions_error(
            &self,
            source_url: &NSURL,
            s_store_type: &NSString,
            s_options: Option<&NSDictionary>,
            mappings: Option<&NSMappingModel>,
            d_url: &NSURL,
            d_store_type: &NSString,
            d_options: Option<&NSDictionary>,
        ) -> Result<(), Retained<NSError>>;

        #[unsafe(method(usesStoreSpecificMigrationManager))]
        #[unsafe(method_family = none)]
        pub unsafe fn usesStoreSpecificMigrationManager(&self) -> bool;

        /// Setter for [`usesStoreSpecificMigrationManager`][Self::usesStoreSpecificMigrationManager].
        #[unsafe(method(setUsesStoreSpecificMigrationManager:))]
        #[unsafe(method_family = none)]
        pub unsafe fn setUsesStoreSpecificMigrationManager(
            &self,
            uses_store_specific_migration_manager: bool,
        );

        #[unsafe(method(reset))]
        #[unsafe(method_family = none)]
        pub unsafe fn reset(&self);

        #[cfg(feature = "NSMappingModel")]
        #[unsafe(method(mappingModel))]
        #[unsafe(method_family = none)]
        pub unsafe fn mappingModel(&self) -> Retained<NSMappingModel>;

        #[cfg(feature = "NSManagedObjectModel")]
        #[unsafe(method(sourceModel))]
        #[unsafe(method_family = none)]
        pub unsafe fn sourceModel(&self) -> Retained<NSManagedObjectModel>;

        #[cfg(feature = "NSManagedObjectModel")]
        #[unsafe(method(destinationModel))]
        #[unsafe(method_family = none)]
        pub unsafe fn destinationModel(&self) -> Retained<NSManagedObjectModel>;

        #[cfg(feature = "NSManagedObjectContext")]
        #[unsafe(method(sourceContext))]
        #[unsafe(method_family = none)]
        pub unsafe fn sourceContext(&self) -> Retained<NSManagedObjectContext>;

        #[cfg(feature = "NSManagedObjectContext")]
        #[unsafe(method(destinationContext))]
        #[unsafe(method_family = none)]
        pub unsafe fn destinationContext(&self) -> Retained<NSManagedObjectContext>;

        #[cfg(all(feature = "NSEntityDescription", feature = "NSEntityMapping"))]
        #[unsafe(method(sourceEntityForEntityMapping:))]
        #[unsafe(method_family = none)]
        pub unsafe fn sourceEntityForEntityMapping(
            &self,
            m_entity: &NSEntityMapping,
        ) -> Option<Retained<NSEntityDescription>>;

        #[cfg(all(feature = "NSEntityDescription", feature = "NSEntityMapping"))]
        #[unsafe(method(destinationEntityForEntityMapping:))]
        #[unsafe(method_family = none)]
        pub unsafe fn destinationEntityForEntityMapping(
            &self,
            m_entity: &NSEntityMapping,
        ) -> Option<Retained<NSEntityDescription>>;

        #[cfg(all(feature = "NSEntityMapping", feature = "NSManagedObject"))]
        #[unsafe(method(associateSourceInstance:withDestinationInstance:forEntityMapping:))]
        #[unsafe(method_family = none)]
        pub unsafe fn associateSourceInstance_withDestinationInstance_forEntityMapping(
            &self,
            source_instance: &NSManagedObject,
            destination_instance: &NSManagedObject,
            entity_mapping: &NSEntityMapping,
        );

        #[cfg(feature = "NSManagedObject")]
        #[unsafe(method(destinationInstancesForEntityMappingNamed:sourceInstances:))]
        #[unsafe(method_family = none)]
        pub unsafe fn destinationInstancesForEntityMappingNamed_sourceInstances(
            &self,
            mapping_name: &NSString,
            source_instances: Option<&NSArray<NSManagedObject>>,
        ) -> Retained<NSArray<NSManagedObject>>;

        #[cfg(feature = "NSManagedObject")]
        #[unsafe(method(sourceInstancesForEntityMappingNamed:destinationInstances:))]
        #[unsafe(method_family = none)]
        pub unsafe fn sourceInstancesForEntityMappingNamed_destinationInstances(
            &self,
            mapping_name: &NSString,
            destination_instances: Option<&NSArray<NSManagedObject>>,
        ) -> Retained<NSArray<NSManagedObject>>;

        #[cfg(feature = "NSEntityMapping")]
        #[unsafe(method(currentEntityMapping))]
        #[unsafe(method_family = none)]
        pub unsafe fn currentEntityMapping(&self) -> Retained<NSEntityMapping>;

        #[unsafe(method(migrationProgress))]
        #[unsafe(method_family = none)]
        pub unsafe fn migrationProgress(&self) -> c_float;

        #[unsafe(method(userInfo))]
        #[unsafe(method_family = none)]
        pub unsafe fn userInfo(&self) -> Option<Retained<NSDictionary>>;

        /// Setter for [`userInfo`][Self::userInfo].
        ///
        /// # Safety
        ///
        /// `user_info` generic should be of the correct type.
        #[unsafe(method(setUserInfo:))]
        #[unsafe(method_family = none)]
        pub unsafe fn setUserInfo(&self, user_info: Option<&NSDictionary>);

        #[unsafe(method(cancelMigrationWithError:))]
        #[unsafe(method_family = none)]
        pub unsafe fn cancelMigrationWithError(&self, error: &NSError);
    );
}

/// Methods declared on superclass `NSObject`.
impl NSMigrationManager {
    extern_methods!(
        #[unsafe(method(init))]
        #[unsafe(method_family = init)]
        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;

        #[unsafe(method(new))]
        #[unsafe(method_family = new)]
        pub unsafe fn new() -> Retained<Self>;
    );
}