cloudkit 0.2.0

Safe Rust bindings for Apple's CloudKit framework — iCloud databases and sync on macOS
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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
use core::ffi::{c_char, c_void};
use core::ptr;

use crate::container::CKContainer;
use crate::error::CloudKitError;
use crate::fetched_results::CKFetchedQueryResults;
use crate::ffi;
use crate::private::{
    box_closure, error_from_status, json_cstring, opt_cstring_ptr, optional_cstring_from_str,
    parse_borrowed_error_ptr, parse_json_ptr, parse_json_str, CKFetchedQueryResultsPayload,
};
use crate::query::CKQuery;
use crate::record::{CKRecord, CKRecordID, CKRecordZone, CKRecordZoneID};
use crate::subscription::CKAnySubscription;

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum CKDatabaseScope {
    Public = 1,
    Private = 2,
    Shared = 3,
}

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CKDatabase {
    container: CKContainer,
    database_scope: CKDatabaseScope,
}

impl CKDatabase {
    pub(crate) const fn new(container: CKContainer, database_scope: CKDatabaseScope) -> Self {
        Self {
            container,
            database_scope,
        }
    }

    pub const fn database_scope(&self) -> CKDatabaseScope {
        self.database_scope
    }

    pub const fn container(&self) -> &CKContainer {
        &self.container
    }

    pub fn save_record(&self, record: &CKRecord) -> Result<CKRecord, CloudKitError> {
        let identifier = optional_cstring_from_str(
            self.container.container_identifier(),
            "container identifier",
        )?;
        let record_json = json_cstring(&record.to_payload(), "record")?;
        let mut out_json: *mut c_char = ptr::null_mut();
        let mut out_error: *mut c_char = ptr::null_mut();
        let status = unsafe {
            ffi::ck_database_save_record_sync(
                opt_cstring_ptr(&identifier),
                self.database_scope as i32,
                record_json.as_ptr(),
                &mut out_json,
                &mut out_error,
            )
        };
        if status != ffi::status::OK {
            return Err(unsafe { error_from_status(status, out_error) });
        }
        let payload =
            unsafe { parse_json_ptr::<crate::private::CKRecordPayload>(out_json, "saved record")? };
        Ok(CKRecord::from_payload(payload))
    }

    pub fn fetch_record(&self, record_id: &CKRecordID) -> Result<CKRecord, CloudKitError> {
        let identifier = optional_cstring_from_str(
            self.container.container_identifier(),
            "container identifier",
        )?;
        let record_id_json = json_cstring(&record_id.to_payload(), "record ID")?;
        let mut out_json: *mut c_char = ptr::null_mut();
        let mut out_error: *mut c_char = ptr::null_mut();
        let status = unsafe {
            ffi::ck_database_fetch_record_sync(
                opt_cstring_ptr(&identifier),
                self.database_scope as i32,
                record_id_json.as_ptr(),
                &mut out_json,
                &mut out_error,
            )
        };
        if status != ffi::status::OK {
            return Err(unsafe { error_from_status(status, out_error) });
        }
        let payload = unsafe {
            parse_json_ptr::<crate::private::CKRecordPayload>(out_json, "fetched record")?
        };
        Ok(CKRecord::from_payload(payload))
    }

    pub fn delete_record(&self, record_id: &CKRecordID) -> Result<CKRecordID, CloudKitError> {
        let identifier = optional_cstring_from_str(
            self.container.container_identifier(),
            "container identifier",
        )?;
        let record_id_json = json_cstring(&record_id.to_payload(), "record ID")?;
        let mut out_json: *mut c_char = ptr::null_mut();
        let mut out_error: *mut c_char = ptr::null_mut();
        let status = unsafe {
            ffi::ck_database_delete_record_sync(
                opt_cstring_ptr(&identifier),
                self.database_scope as i32,
                record_id_json.as_ptr(),
                &mut out_json,
                &mut out_error,
            )
        };
        if status != ffi::status::OK {
            return Err(unsafe { error_from_status(status, out_error) });
        }
        let payload = unsafe {
            parse_json_ptr::<crate::private::CKRecordIDPayload>(out_json, "deleted record ID")?
        };
        Ok(CKRecordID::from_payload(payload))
    }

    pub fn perform_query(
        &self,
        query: &CKQuery,
        zone_id: Option<&CKRecordZoneID>,
    ) -> Result<Vec<CKRecord>, CloudKitError> {
        let identifier = optional_cstring_from_str(
            self.container.container_identifier(),
            "container identifier",
        )?;
        let query_json = json_cstring(&query.to_payload(), "query")?;
        let zone_json = zone_id.map(CKRecordZoneID::to_payload);
        let zone_json = match zone_json.as_ref() {
            Some(zone) => Some(json_cstring(zone, "zone ID")?),
            None => None,
        };
        let mut out_json: *mut c_char = ptr::null_mut();
        let mut out_error: *mut c_char = ptr::null_mut();
        let status = unsafe {
            ffi::ck_database_perform_query_sync(
                opt_cstring_ptr(&identifier),
                self.database_scope as i32,
                query_json.as_ptr(),
                opt_cstring_ptr(&zone_json),
                &mut out_json,
                &mut out_error,
            )
        };
        if status != ffi::status::OK {
            return Err(unsafe { error_from_status(status, out_error) });
        }
        let payloads = unsafe {
            parse_json_ptr::<Vec<crate::private::CKRecordPayload>>(out_json, "query results")?
        };
        Ok(payloads.into_iter().map(CKRecord::from_payload).collect())
    }

    pub fn perform_query_with_completion_handler<F>(
        &self,
        query: &CKQuery,
        zone_id: Option<&CKRecordZoneID>,
        callback: F,
    ) -> Result<(), CloudKitError>
    where
        F: FnOnce(Result<Vec<CKRecord>, CloudKitError>) + Send + 'static,
    {
        let identifier = optional_cstring_from_str(
            self.container.container_identifier(),
            "container identifier",
        )?;
        let query_json = json_cstring(&query.to_payload(), "query")?;
        let zone_json = zone_id.map(CKRecordZoneID::to_payload);
        let zone_json = match zone_json.as_ref() {
            Some(zone) => Some(json_cstring(zone, "zone ID")?),
            None => None,
        };
        let callback_ptr = box_closure(Box::new(callback) as QueryCallback);
        unsafe {
            ffi::ck_database_perform_query_async(
                opt_cstring_ptr(&identifier),
                self.database_scope as i32,
                query_json.as_ptr(),
                opt_cstring_ptr(&zone_json),
                query_callback_trampoline,
                callback_ptr,
            );
        }
        Ok(())
    }

    pub fn fetch_query_results(
        &self,
        query: &CKQuery,
        zone_id: Option<&CKRecordZoneID>,
        desired_keys: Option<Vec<String>>,
        results_limit: Option<usize>,
    ) -> Result<CKFetchedQueryResults, CloudKitError> {
        let identifier = optional_cstring_from_str(
            self.container.container_identifier(),
            "container identifier",
        )?;
        let query_json = json_cstring(&query.to_payload(), "query")?;
        let zone_json = zone_id.map(CKRecordZoneID::to_payload);
        let zone_json = match zone_json.as_ref() {
            Some(zone) => Some(json_cstring(zone, "zone ID")?),
            None => None,
        };
        let desired_keys_json = match desired_keys.as_ref() {
            Some(desired_keys) => Some(json_cstring(desired_keys, "desired keys")?),
            None => None,
        };
        let results_limit = i32::try_from(results_limit.unwrap_or_default()).map_err(|_| {
            CloudKitError::bridge(-1, "results limit exceeds supported i32 range")
        })?;
        let mut out_json: *mut c_char = ptr::null_mut();
        let mut out_error: *mut c_char = ptr::null_mut();
        let status = unsafe {
            ffi::ck_database_fetch_query_results_sync(
                opt_cstring_ptr(&identifier),
                self.database_scope as i32,
                query_json.as_ptr(),
                opt_cstring_ptr(&zone_json),
                opt_cstring_ptr(&desired_keys_json),
                results_limit,
                &mut out_json,
                &mut out_error,
            )
        };
        if status != ffi::status::OK {
            return Err(unsafe { error_from_status(status, out_error) });
        }
        let payload = unsafe {
            parse_json_ptr::<CKFetchedQueryResultsPayload>(out_json, "fetched query results")?
        };
        Ok(CKFetchedQueryResults::from_payload(payload))
    }

    pub fn fetch_all_record_zones(&self) -> Result<Vec<CKRecordZone>, CloudKitError> {
        let identifier = optional_cstring_from_str(
            self.container.container_identifier(),
            "container identifier",
        )?;
        let mut out_json: *mut c_char = ptr::null_mut();
        let mut out_error: *mut c_char = ptr::null_mut();
        let status = unsafe {
            ffi::ck_database_fetch_all_record_zones_sync(
                opt_cstring_ptr(&identifier),
                self.database_scope as i32,
                &mut out_json,
                &mut out_error,
            )
        };
        if status != ffi::status::OK {
            return Err(unsafe { error_from_status(status, out_error) });
        }
        let payloads = unsafe {
            parse_json_ptr::<Vec<crate::private::CKRecordZonePayload>>(out_json, "record zones")?
        };
        Ok(payloads.into_iter().map(CKRecordZone::from_payload).collect())
    }

    pub fn fetch_record_zone(&self, zone_id: &CKRecordZoneID) -> Result<CKRecordZone, CloudKitError> {
        let identifier = optional_cstring_from_str(
            self.container.container_identifier(),
            "container identifier",
        )?;
        let zone_json = json_cstring(&zone_id.to_payload(), "zone ID")?;
        let mut out_json: *mut c_char = ptr::null_mut();
        let mut out_error: *mut c_char = ptr::null_mut();
        let status = unsafe {
            ffi::ck_database_fetch_record_zone_sync(
                opt_cstring_ptr(&identifier),
                self.database_scope as i32,
                zone_json.as_ptr(),
                &mut out_json,
                &mut out_error,
            )
        };
        if status != ffi::status::OK {
            return Err(unsafe { error_from_status(status, out_error) });
        }
        let payload = unsafe {
            parse_json_ptr::<crate::private::CKRecordZonePayload>(out_json, "record zone")?
        };
        Ok(CKRecordZone::from_payload(payload))
    }

    pub fn save_record_zone(&self, zone: &CKRecordZone) -> Result<CKRecordZone, CloudKitError> {
        let identifier = optional_cstring_from_str(
            self.container.container_identifier(),
            "container identifier",
        )?;
        let zone_json = json_cstring(&zone.to_payload(), "record zone")?;
        let mut out_json: *mut c_char = ptr::null_mut();
        let mut out_error: *mut c_char = ptr::null_mut();
        let status = unsafe {
            ffi::ck_database_save_record_zone_sync(
                opt_cstring_ptr(&identifier),
                self.database_scope as i32,
                zone_json.as_ptr(),
                &mut out_json,
                &mut out_error,
            )
        };
        if status != ffi::status::OK {
            return Err(unsafe { error_from_status(status, out_error) });
        }
        let payload = unsafe {
            parse_json_ptr::<crate::private::CKRecordZonePayload>(out_json, "saved record zone")?
        };
        Ok(CKRecordZone::from_payload(payload))
    }

    pub fn delete_record_zone(&self, zone_id: &CKRecordZoneID) -> Result<CKRecordZoneID, CloudKitError> {
        let identifier = optional_cstring_from_str(
            self.container.container_identifier(),
            "container identifier",
        )?;
        let zone_json = json_cstring(&zone_id.to_payload(), "zone ID")?;
        let mut out_json: *mut c_char = ptr::null_mut();
        let mut out_error: *mut c_char = ptr::null_mut();
        let status = unsafe {
            ffi::ck_database_delete_record_zone_sync(
                opt_cstring_ptr(&identifier),
                self.database_scope as i32,
                zone_json.as_ptr(),
                &mut out_json,
                &mut out_error,
            )
        };
        if status != ffi::status::OK {
            return Err(unsafe { error_from_status(status, out_error) });
        }
        let payload = unsafe {
            parse_json_ptr::<crate::private::CKRecordZoneIDPayload>(out_json, "deleted record zone")?
        };
        Ok(CKRecordZoneID::from_payload(payload))
    }

    pub fn fetch_subscription(
        &self,
        subscription_id: &str,
    ) -> Result<CKAnySubscription, CloudKitError> {
        let identifier = optional_cstring_from_str(
            self.container.container_identifier(),
            "container identifier",
        )?;
        let subscription_id = crate::private::cstring_from_str(subscription_id, "subscription ID")?;
        let mut out_json: *mut c_char = ptr::null_mut();
        let mut out_error: *mut c_char = ptr::null_mut();
        let status = unsafe {
            ffi::ck_database_fetch_subscription_sync(
                opt_cstring_ptr(&identifier),
                self.database_scope as i32,
                subscription_id.as_ptr(),
                &mut out_json,
                &mut out_error,
            )
        };
        if status != ffi::status::OK {
            return Err(unsafe { error_from_status(status, out_error) });
        }
        let payload = unsafe {
            parse_json_ptr::<crate::private::CKSubscriptionPayload>(out_json, "subscription")?
        };
        Ok(CKAnySubscription::from_payload(payload))
    }

    pub fn fetch_all_subscriptions(&self) -> Result<Vec<CKAnySubscription>, CloudKitError> {
        let identifier = optional_cstring_from_str(
            self.container.container_identifier(),
            "container identifier",
        )?;
        let mut out_json: *mut c_char = ptr::null_mut();
        let mut out_error: *mut c_char = ptr::null_mut();
        let status = unsafe {
            ffi::ck_database_fetch_all_subscriptions_sync(
                opt_cstring_ptr(&identifier),
                self.database_scope as i32,
                &mut out_json,
                &mut out_error,
            )
        };
        if status != ffi::status::OK {
            return Err(unsafe { error_from_status(status, out_error) });
        }
        let payloads = unsafe {
            parse_json_ptr::<Vec<crate::private::CKSubscriptionPayload>>(out_json, "subscriptions")?
        };
        Ok(payloads.into_iter().map(CKAnySubscription::from_payload).collect())
    }

    pub fn save_subscription<S>(&self, subscription: S) -> Result<CKAnySubscription, CloudKitError>
    where
        S: Into<CKAnySubscription>,
    {
        let subscription = subscription.into();
        let identifier = optional_cstring_from_str(
            self.container.container_identifier(),
            "container identifier",
        )?;
        let subscription_json = json_cstring(&subscription.to_payload(), "subscription")?;
        let mut out_json: *mut c_char = ptr::null_mut();
        let mut out_error: *mut c_char = ptr::null_mut();
        let status = unsafe {
            ffi::ck_database_save_subscription_sync(
                opt_cstring_ptr(&identifier),
                self.database_scope as i32,
                subscription_json.as_ptr(),
                &mut out_json,
                &mut out_error,
            )
        };
        if status != ffi::status::OK {
            return Err(unsafe { error_from_status(status, out_error) });
        }
        let payload = unsafe {
            parse_json_ptr::<crate::private::CKSubscriptionPayload>(out_json, "saved subscription")?
        };
        Ok(CKAnySubscription::from_payload(payload))
    }

    pub fn delete_subscription(&self, subscription_id: &str) -> Result<String, CloudKitError> {
        let identifier = optional_cstring_from_str(
            self.container.container_identifier(),
            "container identifier",
        )?;
        let subscription_id = crate::private::cstring_from_str(subscription_id, "subscription ID")?;
        let mut out_json: *mut c_char = ptr::null_mut();
        let mut out_error: *mut c_char = ptr::null_mut();
        let status = unsafe {
            ffi::ck_database_delete_subscription_sync(
                opt_cstring_ptr(&identifier),
                self.database_scope as i32,
                subscription_id.as_ptr(),
                &mut out_json,
                &mut out_error,
            )
        };
        if status != ffi::status::OK {
            return Err(unsafe { error_from_status(status, out_error) });
        }
        unsafe { parse_json_ptr::<String>(out_json, "deleted subscription ID") }
    }
}

type QueryCallback = Box<dyn FnOnce(Result<Vec<CKRecord>, CloudKitError>) + Send + 'static>;

unsafe extern "C" fn query_callback_trampoline(
    refcon: *mut c_void,
    json: *const c_char,
    error_json: *const c_char,
) {
    let callback: Box<QueryCallback> = Box::from_raw(refcon.cast());
    let result = if error_json.is_null() {
        let payloads = parse_json_str::<Vec<crate::private::CKRecordPayload>>(
            &std::ffi::CStr::from_ptr(json).to_string_lossy(),
            "query results",
        );
        payloads.map(|payloads| payloads.into_iter().map(CKRecord::from_payload).collect())
    } else {
        Err(parse_borrowed_error_ptr(error_json))
    };
    callback(result);
}