cloudkit 0.3.5

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
use core::ops::{BitOr, BitOrAssign};

use crate::notification_info::CKNotificationInfo;
use crate::private::{CKNotificationInfoPayload, CKSubscriptionPayload, CKSubscriptionPayloadKind};
use crate::record::CKRecordZoneID;

/// Mirrors `CKSubscriptionType`.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[non_exhaustive]
pub enum CKSubscriptionType {
    /// Mirrors `CKSubscriptionType.query`.
    Query,
    /// Mirrors `CKSubscriptionType.recordZone`.
    RecordZone,
    /// Mirrors `CKSubscriptionType.database`.
    Database,
    /// Mirrors `CKSubscriptionType.unknown`.
    Unknown(i32),
}

impl CKSubscriptionType {
    pub(crate) const fn to_raw(self) -> i32 {
        match self {
            Self::Query => 1,
            Self::RecordZone => 2,
            Self::Database => 3,
            Self::Unknown(raw) => raw,
        }
    }
}

/// Wraps `CKQuerySubscription.Options`.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default)]
pub struct QuerySubscriptionOptions(u64);

impl QuerySubscriptionOptions {
    /// Mirrors the `firesOnRecordCreation` option on `CKQuerySubscription.Options`.
    pub const FIRES_ON_RECORD_CREATION: Self = Self(1 << 0);
    /// Mirrors the `firesOnRecordUpdate` option on `CKQuerySubscription.Options`.
    pub const FIRES_ON_RECORD_UPDATE: Self = Self(1 << 1);
    /// Mirrors the `firesOnRecordDeletion` option on `CKQuerySubscription.Options`.
    pub const FIRES_ON_RECORD_DELETION: Self = Self(1 << 2);
    /// Mirrors the `firesOnce` option on `CKQuerySubscription.Options`.
    pub const FIRES_ONCE: Self = Self(1 << 3);

    /// Mirrors `CKQuerySubscription.Options.rawValue`.
    pub const fn bits(self) -> u64 {
        self.0
    }
}

impl BitOr for QuerySubscriptionOptions {
    type Output = Self;

    fn bitor(self, rhs: Self) -> Self::Output {
        Self(self.0 | rhs.0)
    }
}

impl BitOrAssign for QuerySubscriptionOptions {
    fn bitor_assign(&mut self, rhs: Self) {
        self.0 |= rhs.0;
    }
}

/// Wraps `CKSubscription`.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CKSubscription {
    subscription_id: String,
    subscription_type: CKSubscriptionType,
    notification_info: CKNotificationInfo,
}

impl CKSubscription {
    /// Creates a wrapper mirroring `CKSubscription`.
    pub fn new(subscription_id: impl Into<String>, subscription_type: CKSubscriptionType) -> Self {
        Self {
            subscription_id: subscription_id.into(),
            subscription_type,
            notification_info: CKNotificationInfo::default(),
        }
    }

    /// Mirrors `CKSubscription.subscriptionID`.
    pub fn subscription_id(&self) -> &str {
        &self.subscription_id
    }

    /// Mirrors `CKSubscription.subscriptionType`.
    pub const fn subscription_type(&self) -> CKSubscriptionType {
        self.subscription_type
    }

    /// Mirrors `CKSubscription.notificationInfo`.
    pub fn notification_info(&self) -> &CKNotificationInfo {
        &self.notification_info
    }

    /// Sets the value mirroring `CKSubscription.notificationInfo`.
    pub fn with_notification_info(mut self, notification_info: CKNotificationInfo) -> Self {
        self.notification_info = notification_info;
        self
    }
}

/// Wraps `CKQuerySubscription`.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CKQuerySubscription {
    base: CKSubscription,
    record_type: String,
    predicate_format: String,
    zone_id: Option<CKRecordZoneID>,
    options: QuerySubscriptionOptions,
}

impl CKQuerySubscription {
    /// Creates a wrapper mirroring `CKQuerySubscription`.
    pub fn new(
        record_type: impl Into<String>,
        predicate_format: impl Into<String>,
        subscription_id: impl Into<String>,
        options: QuerySubscriptionOptions,
    ) -> Self {
        Self {
            base: CKSubscription::new(subscription_id, CKSubscriptionType::Query),
            record_type: record_type.into(),
            predicate_format: predicate_format.into(),
            zone_id: None,
            options,
        }
    }

    /// Mirrors `CKQuerySubscription.base`.
    pub const fn base(&self) -> &CKSubscription {
        &self.base
    }

    /// Mirrors `CKQuerySubscription.recordType`.
    pub fn record_type(&self) -> &str {
        &self.record_type
    }

    /// Mirrors `CKQuerySubscription.predicateFormat`.
    pub fn predicate_format(&self) -> &str {
        &self.predicate_format
    }

    /// Mirrors `CKQuerySubscription.zoneID`.
    pub const fn zone_id(&self) -> Option<&CKRecordZoneID> {
        self.zone_id.as_ref()
    }

    /// Mirrors `CKQuerySubscription.options`.
    pub const fn options(&self) -> QuerySubscriptionOptions {
        self.options
    }

    /// Sets the value mirroring `CKQuerySubscription.zoneID`.
    pub fn with_zone_id(mut self, zone_id: CKRecordZoneID) -> Self {
        self.zone_id = Some(zone_id);
        self
    }

    /// Sets the value mirroring `CKQuerySubscription.notificationInfo`.
    pub fn with_notification_info(mut self, notification_info: CKNotificationInfo) -> Self {
        self.base = self.base.clone().with_notification_info(notification_info);
        self
    }

    pub(crate) fn from_payload(payload: CKSubscriptionPayload) -> Self {
        let mut subscription = Self::new(
            payload.record_type.unwrap_or_default(),
            payload
                .predicate_format
                .unwrap_or_else(|| "TRUEPREDICATE".into()),
            payload.subscription_id,
            QuerySubscriptionOptions(payload.query_subscription_options.unwrap_or_default()),
        );
        if let Some(zone_id) = payload.zone_id {
            subscription.zone_id = Some(CKRecordZoneID::from_payload(zone_id));
        }
        if let Some(notification_info) = payload.notification_info {
            subscription.base.notification_info =
                CKNotificationInfo::from_payload(notification_info);
        }
        subscription
    }

    pub(crate) fn to_payload(&self) -> CKSubscriptionPayload {
        CKSubscriptionPayload {
            kind: CKSubscriptionPayloadKind::Query,
            subscription_id: self.base.subscription_id.clone(),
            subscription_type: self.base.subscription_type.to_raw(),
            notification_info: Some(self.base.notification_info.to_payload()),
            record_type: Some(self.record_type.clone()),
            predicate_format: Some(self.predicate_format.clone()),
            zone_id: self.zone_id.as_ref().map(CKRecordZoneID::to_payload),
            query_subscription_options: Some(self.options.bits()),
        }
    }
}

/// Wraps `CKRecordZoneSubscription`.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CKRecordZoneSubscription {
    base: CKSubscription,
    zone_id: CKRecordZoneID,
    record_type: Option<String>,
}

impl CKRecordZoneSubscription {
    /// Creates a wrapper mirroring `CKRecordZoneSubscription`.
    pub fn new(zone_id: CKRecordZoneID, subscription_id: impl Into<String>) -> Self {
        Self {
            base: CKSubscription::new(subscription_id, CKSubscriptionType::RecordZone),
            zone_id,
            record_type: None,
        }
    }

    /// Mirrors `CKRecordZoneSubscription.base`.
    pub const fn base(&self) -> &CKSubscription {
        &self.base
    }

    /// Mirrors `CKRecordZoneSubscription.zoneID`.
    pub const fn zone_id(&self) -> &CKRecordZoneID {
        &self.zone_id
    }

    /// Mirrors `CKRecordZoneSubscription.recordType`.
    pub fn record_type(&self) -> Option<&str> {
        self.record_type.as_deref()
    }

    /// Sets the value mirroring `CKRecordZoneSubscription.recordType`.
    pub fn with_record_type(mut self, record_type: impl Into<String>) -> Self {
        self.record_type = Some(record_type.into());
        self
    }

    /// Sets the value mirroring `CKRecordZoneSubscription.notificationInfo`.
    pub fn with_notification_info(mut self, notification_info: CKNotificationInfo) -> Self {
        self.base = self.base.clone().with_notification_info(notification_info);
        self
    }

    pub(crate) fn from_payload(payload: CKSubscriptionPayload) -> Self {
        let mut subscription = Self::new(
            payload
                .zone_id
                .map_or_else(CKRecordZoneID::default_zone, CKRecordZoneID::from_payload),
            payload.subscription_id,
        );
        subscription.record_type = payload.record_type;
        if let Some(notification_info) = payload.notification_info {
            subscription.base.notification_info =
                CKNotificationInfo::from_payload(notification_info);
        }
        subscription
    }

    pub(crate) fn to_payload(&self) -> CKSubscriptionPayload {
        CKSubscriptionPayload {
            kind: CKSubscriptionPayloadKind::RecordZone,
            subscription_id: self.base.subscription_id.clone(),
            subscription_type: self.base.subscription_type.to_raw(),
            notification_info: Some(self.base.notification_info.to_payload()),
            record_type: self.record_type.clone(),
            predicate_format: None,
            zone_id: Some(self.zone_id.to_payload()),
            query_subscription_options: None,
        }
    }
}

/// Wraps `CKDatabaseSubscription`.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct CKDatabaseSubscription {
    base: CKSubscription,
    record_type: Option<String>,
}

impl CKDatabaseSubscription {
    /// Creates a wrapper mirroring `CKDatabaseSubscription`.
    pub fn new(subscription_id: impl Into<String>) -> Self {
        Self {
            base: CKSubscription::new(subscription_id, CKSubscriptionType::Database),
            record_type: None,
        }
    }

    /// Mirrors `CKDatabaseSubscription.base`.
    pub const fn base(&self) -> &CKSubscription {
        &self.base
    }

    /// Mirrors `CKDatabaseSubscription.recordType`.
    pub fn record_type(&self) -> Option<&str> {
        self.record_type.as_deref()
    }

    /// Sets the value mirroring `CKDatabaseSubscription.recordType`.
    pub fn with_record_type(mut self, record_type: impl Into<String>) -> Self {
        self.record_type = Some(record_type.into());
        self
    }

    /// Sets the value mirroring `CKDatabaseSubscription.notificationInfo`.
    pub fn with_notification_info(mut self, notification_info: CKNotificationInfo) -> Self {
        self.base = self.base.clone().with_notification_info(notification_info);
        self
    }

    pub(crate) fn from_payload(payload: CKSubscriptionPayload) -> Self {
        let mut subscription = Self::new(payload.subscription_id);
        subscription.record_type = payload.record_type;
        if let Some(notification_info) = payload.notification_info {
            subscription.base.notification_info =
                CKNotificationInfo::from_payload(notification_info);
        }
        subscription
    }

    pub(crate) fn to_payload(&self) -> CKSubscriptionPayload {
        CKSubscriptionPayload {
            kind: CKSubscriptionPayloadKind::Database,
            subscription_id: self.base.subscription_id.clone(),
            subscription_type: self.base.subscription_type.to_raw(),
            notification_info: Some(self.base.notification_info.to_payload()),
            record_type: self.record_type.clone(),
            predicate_format: None,
            zone_id: None,
            query_subscription_options: None,
        }
    }
}

/// Mirrors `CKAnySubscription`.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
#[non_exhaustive]
pub enum CKAnySubscription {
    /// Mirrors `CKAnySubscription.query`.
    Query(CKQuerySubscription),
    /// Mirrors `CKAnySubscription.recordZone`.
    RecordZone(CKRecordZoneSubscription),
    /// Mirrors `CKAnySubscription.database`.
    Database(CKDatabaseSubscription),
}

impl CKAnySubscription {
    /// Mirrors `CKAnySubscription.subscriptionID`.
    pub fn subscription_id(&self) -> &str {
        match self {
            Self::Query(subscription) => subscription.base().subscription_id(),
            Self::RecordZone(subscription) => subscription.base().subscription_id(),
            Self::Database(subscription) => subscription.base().subscription_id(),
        }
    }

    /// Mirrors `CKAnySubscription.notificationInfo`.
    pub fn notification_info(&self) -> &CKNotificationInfo {
        match self {
            Self::Query(subscription) => subscription.base().notification_info(),
            Self::RecordZone(subscription) => subscription.base().notification_info(),
            Self::Database(subscription) => subscription.base().notification_info(),
        }
    }

    /// Mirrors `CKAnySubscription.subscriptionType`.
    pub const fn subscription_type(&self) -> CKSubscriptionType {
        match self {
            Self::Query(subscription) => subscription.base().subscription_type(),
            Self::RecordZone(subscription) => subscription.base().subscription_type(),
            Self::Database(subscription) => subscription.base().subscription_type(),
        }
    }

    pub(crate) fn from_payload(payload: CKSubscriptionPayload) -> Self {
        match payload.kind {
            CKSubscriptionPayloadKind::Query => {
                Self::Query(CKQuerySubscription::from_payload(payload))
            }
            CKSubscriptionPayloadKind::RecordZone => {
                Self::RecordZone(CKRecordZoneSubscription::from_payload(payload))
            }
            CKSubscriptionPayloadKind::Database => {
                Self::Database(CKDatabaseSubscription::from_payload(payload))
            }
        }
    }

    pub(crate) fn to_payload(&self) -> CKSubscriptionPayload {
        match self {
            Self::Query(subscription) => subscription.to_payload(),
            Self::RecordZone(subscription) => subscription.to_payload(),
            Self::Database(subscription) => subscription.to_payload(),
        }
    }
}

impl From<CKQuerySubscription> for CKAnySubscription {
    fn from(value: CKQuerySubscription) -> Self {
        Self::Query(value)
    }
}

impl From<CKRecordZoneSubscription> for CKAnySubscription {
    fn from(value: CKRecordZoneSubscription) -> Self {
        Self::RecordZone(value)
    }
}

impl From<CKDatabaseSubscription> for CKAnySubscription {
    fn from(value: CKDatabaseSubscription) -> Self {
        Self::Database(value)
    }
}

impl From<CKNotificationInfoPayload> for CKNotificationInfo {
    fn from(value: CKNotificationInfoPayload) -> Self {
        CKNotificationInfo::from_payload(value)
    }
}