objc2_core_data/generated/
NSPersistentStore.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/nspersistentstore?language=objc)
12    #[unsafe(super(NSObject))]
13    #[derive(Debug, PartialEq, Eq, Hash)]
14    pub struct NSPersistentStore;
15);
16
17extern_conformance!(
18    unsafe impl NSObjectProtocol for NSPersistentStore {}
19);
20
21impl NSPersistentStore {
22    extern_methods!(
23        #[unsafe(method(metadataForPersistentStoreWithURL:error:_))]
24        #[unsafe(method_family = none)]
25        pub unsafe fn metadataForPersistentStoreWithURL_error(
26            url: &NSURL,
27        ) -> Result<Retained<NSDictionary<NSString, AnyObject>>, Retained<NSError>>;
28
29        #[unsafe(method(setMetadata:forPersistentStoreWithURL:error:_))]
30        #[unsafe(method_family = none)]
31        pub unsafe fn setMetadata_forPersistentStoreWithURL_error(
32            metadata: Option<&NSDictionary<NSString, AnyObject>>,
33            url: &NSURL,
34        ) -> Result<(), Retained<NSError>>;
35
36        #[unsafe(method(migrationManagerClass))]
37        #[unsafe(method_family = none)]
38        pub unsafe fn migrationManagerClass() -> &'static AnyClass;
39
40        #[cfg(feature = "NSPersistentStoreCoordinator")]
41        #[unsafe(method(initWithPersistentStoreCoordinator:configurationName:URL:options:))]
42        #[unsafe(method_family = init)]
43        pub unsafe fn initWithPersistentStoreCoordinator_configurationName_URL_options(
44            this: Allocated<Self>,
45            root: Option<&NSPersistentStoreCoordinator>,
46            name: Option<&NSString>,
47            url: &NSURL,
48            options: Option<&NSDictionary>,
49        ) -> Retained<Self>;
50
51        #[unsafe(method(init))]
52        #[unsafe(method_family = init)]
53        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
54
55        #[unsafe(method(loadMetadata:_))]
56        #[unsafe(method_family = none)]
57        pub unsafe fn loadMetadata(&self) -> Result<(), Retained<NSError>>;
58
59        #[cfg(feature = "NSPersistentStoreCoordinator")]
60        #[unsafe(method(persistentStoreCoordinator))]
61        #[unsafe(method_family = none)]
62        pub unsafe fn persistentStoreCoordinator(
63            &self,
64        ) -> Option<Retained<NSPersistentStoreCoordinator>>;
65
66        #[unsafe(method(configurationName))]
67        #[unsafe(method_family = none)]
68        pub unsafe fn configurationName(&self) -> Retained<NSString>;
69
70        #[unsafe(method(options))]
71        #[unsafe(method_family = none)]
72        pub unsafe fn options(&self) -> Option<Retained<NSDictionary>>;
73
74        #[unsafe(method(URL))]
75        #[unsafe(method_family = none)]
76        pub unsafe fn URL(&self) -> Option<Retained<NSURL>>;
77
78        /// Setter for [`URL`][Self::URL].
79        #[unsafe(method(setURL:))]
80        #[unsafe(method_family = none)]
81        pub unsafe fn setURL(&self, url: Option<&NSURL>);
82
83        #[unsafe(method(identifier))]
84        #[unsafe(method_family = none)]
85        pub unsafe fn identifier(&self) -> Retained<NSString>;
86
87        /// Setter for [`identifier`][Self::identifier].
88        #[unsafe(method(setIdentifier:))]
89        #[unsafe(method_family = none)]
90        pub unsafe fn setIdentifier(&self, identifier: Option<&NSString>);
91
92        #[unsafe(method(type))]
93        #[unsafe(method_family = none)]
94        pub unsafe fn r#type(&self) -> Retained<NSString>;
95
96        #[unsafe(method(isReadOnly))]
97        #[unsafe(method_family = none)]
98        pub unsafe fn isReadOnly(&self) -> bool;
99
100        /// Setter for [`isReadOnly`][Self::isReadOnly].
101        #[unsafe(method(setReadOnly:))]
102        #[unsafe(method_family = none)]
103        pub unsafe fn setReadOnly(&self, read_only: bool);
104
105        #[unsafe(method(metadata))]
106        #[unsafe(method_family = none)]
107        pub unsafe fn metadata(&self) -> Option<Retained<NSDictionary<NSString, AnyObject>>>;
108
109        /// Setter for [`metadata`][Self::metadata].
110        #[unsafe(method(setMetadata:))]
111        #[unsafe(method_family = none)]
112        pub unsafe fn setMetadata(&self, metadata: Option<&NSDictionary<NSString, AnyObject>>);
113
114        #[cfg(feature = "NSPersistentStoreCoordinator")]
115        #[unsafe(method(didAddToPersistentStoreCoordinator:))]
116        #[unsafe(method_family = none)]
117        pub unsafe fn didAddToPersistentStoreCoordinator(
118            &self,
119            coordinator: &NSPersistentStoreCoordinator,
120        );
121
122        #[cfg(feature = "NSPersistentStoreCoordinator")]
123        #[unsafe(method(willRemoveFromPersistentStoreCoordinator:))]
124        #[unsafe(method_family = none)]
125        pub unsafe fn willRemoveFromPersistentStoreCoordinator(
126            &self,
127            coordinator: Option<&NSPersistentStoreCoordinator>,
128        );
129
130        #[cfg(feature = "NSCoreDataCoreSpotlightDelegate")]
131        #[unsafe(method(coreSpotlightExporter))]
132        #[unsafe(method_family = none)]
133        pub unsafe fn coreSpotlightExporter(&self) -> Retained<NSCoreDataCoreSpotlightDelegate>;
134    );
135}
136
137/// Methods declared on superclass `NSObject`.
138impl NSPersistentStore {
139    extern_methods!(
140        #[unsafe(method(new))]
141        #[unsafe(method_family = new)]
142        pub unsafe fn new() -> Retained<Self>;
143    );
144}