objc2-photos 0.2.0

Bindings to the Photos/PhotoKit 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
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
466
467
//! This file has been automatically generated by `objc2`'s `header-translator`.
//! DO NOT EDIT
#[cfg(feature = "block2")]
use block2::*;
use objc2::__framework_prelude::*;
#[cfg(feature = "objc2-app-kit")]
use objc2_app_kit::*;
use objc2_foundation::*;

use crate::*;

// NS_ENUM
#[repr(transparent)]
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct PHImageRequestOptionsVersion(pub NSInteger);
impl PHImageRequestOptionsVersion {
    #[doc(alias = "PHImageRequestOptionsVersionCurrent")]
    pub const Current: Self = Self(0);
    #[doc(alias = "PHImageRequestOptionsVersionUnadjusted")]
    pub const Unadjusted: Self = Self(1);
    #[doc(alias = "PHImageRequestOptionsVersionOriginal")]
    pub const Original: Self = Self(2);
}

unsafe impl Encode for PHImageRequestOptionsVersion {
    const ENCODING: Encoding = NSInteger::ENCODING;
}

unsafe impl RefEncode for PHImageRequestOptionsVersion {
    const ENCODING_REF: Encoding = Encoding::Pointer(&Self::ENCODING);
}

// NS_ENUM
#[repr(transparent)]
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct PHImageRequestOptionsDeliveryMode(pub NSInteger);
impl PHImageRequestOptionsDeliveryMode {
    #[doc(alias = "PHImageRequestOptionsDeliveryModeOpportunistic")]
    pub const Opportunistic: Self = Self(0);
    #[doc(alias = "PHImageRequestOptionsDeliveryModeHighQualityFormat")]
    pub const HighQualityFormat: Self = Self(1);
    #[doc(alias = "PHImageRequestOptionsDeliveryModeFastFormat")]
    pub const FastFormat: Self = Self(2);
}

unsafe impl Encode for PHImageRequestOptionsDeliveryMode {
    const ENCODING: Encoding = NSInteger::ENCODING;
}

unsafe impl RefEncode for PHImageRequestOptionsDeliveryMode {
    const ENCODING_REF: Encoding = Encoding::Pointer(&Self::ENCODING);
}

// NS_ENUM
#[repr(transparent)]
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct PHImageRequestOptionsResizeMode(pub NSInteger);
impl PHImageRequestOptionsResizeMode {
    #[doc(alias = "PHImageRequestOptionsResizeModeNone")]
    pub const None: Self = Self(0);
    #[doc(alias = "PHImageRequestOptionsResizeModeFast")]
    pub const Fast: Self = Self(1);
    #[doc(alias = "PHImageRequestOptionsResizeModeExact")]
    pub const Exact: Self = Self(2);
}

unsafe impl Encode for PHImageRequestOptionsResizeMode {
    const ENCODING: Encoding = NSInteger::ENCODING;
}

unsafe impl RefEncode for PHImageRequestOptionsResizeMode {
    const ENCODING_REF: Encoding = Encoding::Pointer(&Self::ENCODING);
}

#[cfg(feature = "block2")]
pub type PHAssetImageProgressHandler =
    *mut Block<dyn Fn(c_double, *mut NSError, NonNull<Bool>, *mut NSDictionary)>;

extern_class!(
    #[derive(Debug, PartialEq, Eq, Hash)]
    pub struct PHImageRequestOptions;

    unsafe impl ClassType for PHImageRequestOptions {
        type Super = NSObject;
        type Mutability = InteriorMutable;
    }
);

unsafe impl NSCopying for PHImageRequestOptions {}

unsafe impl NSObjectProtocol for PHImageRequestOptions {}

extern_methods!(
    unsafe impl PHImageRequestOptions {
        #[method(version)]
        pub unsafe fn version(&self) -> PHImageRequestOptionsVersion;

        #[method(setVersion:)]
        pub unsafe fn setVersion(&self, version: PHImageRequestOptionsVersion);

        #[method(deliveryMode)]
        pub unsafe fn deliveryMode(&self) -> PHImageRequestOptionsDeliveryMode;

        #[method(setDeliveryMode:)]
        pub unsafe fn setDeliveryMode(&self, delivery_mode: PHImageRequestOptionsDeliveryMode);

        #[method(resizeMode)]
        pub unsafe fn resizeMode(&self) -> PHImageRequestOptionsResizeMode;

        #[method(setResizeMode:)]
        pub unsafe fn setResizeMode(&self, resize_mode: PHImageRequestOptionsResizeMode);

        #[method(normalizedCropRect)]
        pub unsafe fn normalizedCropRect(&self) -> CGRect;

        #[method(setNormalizedCropRect:)]
        pub unsafe fn setNormalizedCropRect(&self, normalized_crop_rect: CGRect);

        #[method(isNetworkAccessAllowed)]
        pub unsafe fn isNetworkAccessAllowed(&self) -> bool;

        #[method(setNetworkAccessAllowed:)]
        pub unsafe fn setNetworkAccessAllowed(&self, network_access_allowed: bool);

        #[method(isSynchronous)]
        pub unsafe fn isSynchronous(&self) -> bool;

        #[method(setSynchronous:)]
        pub unsafe fn setSynchronous(&self, synchronous: bool);

        #[cfg(feature = "block2")]
        #[method(progressHandler)]
        pub unsafe fn progressHandler(&self) -> PHAssetImageProgressHandler;

        #[cfg(feature = "block2")]
        #[method(setProgressHandler:)]
        pub unsafe fn setProgressHandler(&self, progress_handler: PHAssetImageProgressHandler);

        #[method(allowSecondaryDegradedImage)]
        pub unsafe fn allowSecondaryDegradedImage(&self) -> bool;

        #[method(setAllowSecondaryDegradedImage:)]
        pub unsafe fn setAllowSecondaryDegradedImage(&self, allow_secondary_degraded_image: bool);
    }
);

extern_methods!(
    /// Methods declared on superclass `NSObject`
    unsafe impl PHImageRequestOptions {
        #[method_id(@__retain_semantics Init init)]
        pub unsafe fn init(this: Allocated<Self>) -> Id<Self>;

        #[method_id(@__retain_semantics New new)]
        pub unsafe fn new() -> Id<Self>;
    }
);

extern_class!(
    #[derive(Debug, PartialEq, Eq, Hash)]
    pub struct PHLivePhotoRequestOptions;

    unsafe impl ClassType for PHLivePhotoRequestOptions {
        type Super = NSObject;
        type Mutability = InteriorMutable;
    }
);

unsafe impl NSCopying for PHLivePhotoRequestOptions {}

unsafe impl NSObjectProtocol for PHLivePhotoRequestOptions {}

extern_methods!(
    unsafe impl PHLivePhotoRequestOptions {
        #[method(version)]
        pub unsafe fn version(&self) -> PHImageRequestOptionsVersion;

        #[method(setVersion:)]
        pub unsafe fn setVersion(&self, version: PHImageRequestOptionsVersion);

        #[method(deliveryMode)]
        pub unsafe fn deliveryMode(&self) -> PHImageRequestOptionsDeliveryMode;

        #[method(setDeliveryMode:)]
        pub unsafe fn setDeliveryMode(&self, delivery_mode: PHImageRequestOptionsDeliveryMode);

        #[method(isNetworkAccessAllowed)]
        pub unsafe fn isNetworkAccessAllowed(&self) -> bool;

        #[method(setNetworkAccessAllowed:)]
        pub unsafe fn setNetworkAccessAllowed(&self, network_access_allowed: bool);

        #[cfg(feature = "block2")]
        #[method(progressHandler)]
        pub unsafe fn progressHandler(&self) -> PHAssetImageProgressHandler;

        #[cfg(feature = "block2")]
        #[method(setProgressHandler:)]
        pub unsafe fn setProgressHandler(&self, progress_handler: PHAssetImageProgressHandler);
    }
);

extern_methods!(
    /// Methods declared on superclass `NSObject`
    unsafe impl PHLivePhotoRequestOptions {
        #[method_id(@__retain_semantics Init init)]
        pub unsafe fn init(this: Allocated<Self>) -> Id<Self>;

        #[method_id(@__retain_semantics New new)]
        pub unsafe fn new() -> Id<Self>;
    }
);

// NS_ENUM
#[repr(transparent)]
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct PHVideoRequestOptionsVersion(pub NSInteger);
impl PHVideoRequestOptionsVersion {
    #[doc(alias = "PHVideoRequestOptionsVersionCurrent")]
    pub const Current: Self = Self(0);
    #[doc(alias = "PHVideoRequestOptionsVersionOriginal")]
    pub const Original: Self = Self(1);
}

unsafe impl Encode for PHVideoRequestOptionsVersion {
    const ENCODING: Encoding = NSInteger::ENCODING;
}

unsafe impl RefEncode for PHVideoRequestOptionsVersion {
    const ENCODING_REF: Encoding = Encoding::Pointer(&Self::ENCODING);
}

// NS_ENUM
#[repr(transparent)]
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct PHVideoRequestOptionsDeliveryMode(pub NSInteger);
impl PHVideoRequestOptionsDeliveryMode {
    #[doc(alias = "PHVideoRequestOptionsDeliveryModeAutomatic")]
    pub const Automatic: Self = Self(0);
    #[doc(alias = "PHVideoRequestOptionsDeliveryModeHighQualityFormat")]
    pub const HighQualityFormat: Self = Self(1);
    #[doc(alias = "PHVideoRequestOptionsDeliveryModeMediumQualityFormat")]
    pub const MediumQualityFormat: Self = Self(2);
    #[doc(alias = "PHVideoRequestOptionsDeliveryModeFastFormat")]
    pub const FastFormat: Self = Self(3);
}

unsafe impl Encode for PHVideoRequestOptionsDeliveryMode {
    const ENCODING: Encoding = NSInteger::ENCODING;
}

unsafe impl RefEncode for PHVideoRequestOptionsDeliveryMode {
    const ENCODING_REF: Encoding = Encoding::Pointer(&Self::ENCODING);
}

#[cfg(feature = "block2")]
pub type PHAssetVideoProgressHandler =
    *mut Block<dyn Fn(c_double, *mut NSError, NonNull<Bool>, *mut NSDictionary)>;

extern_class!(
    #[derive(Debug, PartialEq, Eq, Hash)]
    pub struct PHVideoRequestOptions;

    unsafe impl ClassType for PHVideoRequestOptions {
        type Super = NSObject;
        type Mutability = InteriorMutable;
    }
);

unsafe impl NSCopying for PHVideoRequestOptions {}

unsafe impl NSObjectProtocol for PHVideoRequestOptions {}

extern_methods!(
    unsafe impl PHVideoRequestOptions {
        #[method(isNetworkAccessAllowed)]
        pub unsafe fn isNetworkAccessAllowed(&self) -> bool;

        #[method(setNetworkAccessAllowed:)]
        pub unsafe fn setNetworkAccessAllowed(&self, network_access_allowed: bool);

        #[method(version)]
        pub unsafe fn version(&self) -> PHVideoRequestOptionsVersion;

        #[method(setVersion:)]
        pub unsafe fn setVersion(&self, version: PHVideoRequestOptionsVersion);

        #[method(deliveryMode)]
        pub unsafe fn deliveryMode(&self) -> PHVideoRequestOptionsDeliveryMode;

        #[method(setDeliveryMode:)]
        pub unsafe fn setDeliveryMode(&self, delivery_mode: PHVideoRequestOptionsDeliveryMode);

        #[cfg(feature = "block2")]
        #[method(progressHandler)]
        pub unsafe fn progressHandler(&self) -> PHAssetVideoProgressHandler;

        #[cfg(feature = "block2")]
        #[method(setProgressHandler:)]
        pub unsafe fn setProgressHandler(&self, progress_handler: PHAssetVideoProgressHandler);
    }
);

extern_methods!(
    /// Methods declared on superclass `NSObject`
    unsafe impl PHVideoRequestOptions {
        #[method_id(@__retain_semantics Init init)]
        pub unsafe fn init(this: Allocated<Self>) -> Id<Self>;

        #[method_id(@__retain_semantics New new)]
        pub unsafe fn new() -> Id<Self>;
    }
);

pub type PHImageRequestID = i32;

pub static PHInvalidImageRequestID: PHImageRequestID = 0;

extern "C" {
    pub static PHImageManagerMaximumSize: CGSize;
}

extern "C" {
    pub static PHImageResultIsInCloudKey: &'static NSString;
}

extern "C" {
    pub static PHImageResultIsDegradedKey: &'static NSString;
}

extern "C" {
    pub static PHImageResultRequestIDKey: &'static NSString;
}

extern "C" {
    pub static PHImageCancelledKey: &'static NSString;
}

extern "C" {
    pub static PHImageErrorKey: &'static NSString;
}

extern_class!(
    #[derive(Debug, PartialEq, Eq, Hash)]
    pub struct PHImageManager;

    unsafe impl ClassType for PHImageManager {
        type Super = NSObject;
        type Mutability = InteriorMutable;
    }
);

unsafe impl NSObjectProtocol for PHImageManager {}

extern_methods!(
    unsafe impl PHImageManager {
        #[method_id(@__retain_semantics Other defaultManager)]
        pub unsafe fn defaultManager() -> Id<PHImageManager>;

        #[cfg(all(
            feature = "PHAsset",
            feature = "PHObject",
            feature = "PhotosTypes",
            feature = "block2",
            feature = "objc2-app-kit"
        ))]
        #[method(requestImageForAsset:targetSize:contentMode:options:resultHandler:)]
        pub unsafe fn requestImageForAsset_targetSize_contentMode_options_resultHandler(
            &self,
            asset: &PHAsset,
            target_size: CGSize,
            content_mode: PHImageContentMode,
            options: Option<&PHImageRequestOptions>,
            result_handler: &Block<dyn Fn(*mut NSImage, *mut NSDictionary)>,
        ) -> PHImageRequestID;

        #[method(cancelImageRequest:)]
        pub unsafe fn cancelImageRequest(&self, request_id: PHImageRequestID);

        #[cfg(all(
            feature = "PHAsset",
            feature = "PHLivePhoto",
            feature = "PHObject",
            feature = "PhotosTypes",
            feature = "block2"
        ))]
        #[method(requestLivePhotoForAsset:targetSize:contentMode:options:resultHandler:)]
        pub unsafe fn requestLivePhotoForAsset_targetSize_contentMode_options_resultHandler(
            &self,
            asset: &PHAsset,
            target_size: CGSize,
            content_mode: PHImageContentMode,
            options: Option<&PHLivePhotoRequestOptions>,
            result_handler: &Block<dyn Fn(*mut PHLivePhoto, *mut NSDictionary)>,
        ) -> PHImageRequestID;
    }
);

extern_methods!(
    /// Methods declared on superclass `NSObject`
    unsafe impl PHImageManager {
        #[method_id(@__retain_semantics Init init)]
        pub unsafe fn init(this: Allocated<Self>) -> Id<Self>;

        #[method_id(@__retain_semantics New new)]
        pub unsafe fn new() -> Id<Self>;
    }
);

extern_class!(
    #[derive(Debug, PartialEq, Eq, Hash)]
    pub struct PHCachingImageManager;

    unsafe impl ClassType for PHCachingImageManager {
        #[inherits(NSObject)]
        type Super = PHImageManager;
        type Mutability = InteriorMutable;
    }
);

unsafe impl NSObjectProtocol for PHCachingImageManager {}

extern_methods!(
    unsafe impl PHCachingImageManager {
        #[method(allowsCachingHighQualityImages)]
        pub unsafe fn allowsCachingHighQualityImages(&self) -> bool;

        #[method(setAllowsCachingHighQualityImages:)]
        pub unsafe fn setAllowsCachingHighQualityImages(
            &self,
            allows_caching_high_quality_images: bool,
        );

        #[cfg(all(feature = "PHAsset", feature = "PHObject", feature = "PhotosTypes"))]
        #[method(startCachingImagesForAssets:targetSize:contentMode:options:)]
        pub unsafe fn startCachingImagesForAssets_targetSize_contentMode_options(
            &self,
            assets: &NSArray<PHAsset>,
            target_size: CGSize,
            content_mode: PHImageContentMode,
            options: Option<&PHImageRequestOptions>,
        );

        #[cfg(all(feature = "PHAsset", feature = "PHObject", feature = "PhotosTypes"))]
        #[method(stopCachingImagesForAssets:targetSize:contentMode:options:)]
        pub unsafe fn stopCachingImagesForAssets_targetSize_contentMode_options(
            &self,
            assets: &NSArray<PHAsset>,
            target_size: CGSize,
            content_mode: PHImageContentMode,
            options: Option<&PHImageRequestOptions>,
        );

        #[method(stopCachingImagesForAllAssets)]
        pub unsafe fn stopCachingImagesForAllAssets(&self);
    }
);

extern_methods!(
    /// Methods declared on superclass `NSObject`
    unsafe impl PHCachingImageManager {
        #[method_id(@__retain_semantics Init init)]
        pub unsafe fn init(this: Allocated<Self>) -> Id<Self>;

        #[method_id(@__retain_semantics New new)]
        pub unsafe fn new() -> Id<Self>;
    }
);