objc2-foundation 0.3.2

Bindings to the Foundation 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
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
//! 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 crate::*;

extern_class!(
    /// [Apple's documentation](https://developer.apple.com/documentation/foundation/nsconnection?language=objc)
    #[unsafe(super(NSObject))]
    #[derive(Debug, PartialEq, Eq, Hash)]
    #[deprecated = "Use NSXPCConnection instead"]
    pub struct NSConnection;
);

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

impl NSConnection {
    extern_methods!(
        #[cfg(all(feature = "NSDictionary", feature = "NSString", feature = "NSValue"))]
        #[deprecated = "Use NSXPCConnection instead"]
        #[unsafe(method(statistics))]
        #[unsafe(method_family = none)]
        pub fn statistics(&self) -> Retained<NSDictionary<NSString, NSNumber>>;

        #[cfg(feature = "NSArray")]
        #[deprecated = "Use NSXPCConnection instead"]
        #[unsafe(method(allConnections))]
        #[unsafe(method_family = none)]
        pub fn allConnections() -> Retained<NSArray<NSConnection>>;

        #[deprecated]
        #[unsafe(method(defaultConnection))]
        #[unsafe(method_family = none)]
        pub fn defaultConnection() -> Retained<NSConnection>;

        #[cfg(feature = "NSString")]
        #[deprecated = "Use NSXPCConnection instead"]
        #[unsafe(method(connectionWithRegisteredName:host:))]
        #[unsafe(method_family = none)]
        pub fn connectionWithRegisteredName_host(
            name: &NSString,
            host_name: Option<&NSString>,
        ) -> Option<Retained<Self>>;

        #[cfg(all(feature = "NSPortNameServer", feature = "NSString"))]
        #[deprecated = "Use NSXPCConnection instead"]
        #[unsafe(method(connectionWithRegisteredName:host:usingNameServer:))]
        #[unsafe(method_family = none)]
        pub fn connectionWithRegisteredName_host_usingNameServer(
            name: &NSString,
            host_name: Option<&NSString>,
            server: &NSPortNameServer,
        ) -> Option<Retained<Self>>;

        #[cfg(all(feature = "NSDistantObject", feature = "NSProxy", feature = "NSString"))]
        #[deprecated = "Use NSXPCConnection instead"]
        #[unsafe(method(rootProxyForConnectionWithRegisteredName:host:))]
        #[unsafe(method_family = none)]
        pub fn rootProxyForConnectionWithRegisteredName_host(
            name: &NSString,
            host_name: Option<&NSString>,
        ) -> Option<Retained<NSDistantObject>>;

        #[cfg(all(
            feature = "NSDistantObject",
            feature = "NSPortNameServer",
            feature = "NSProxy",
            feature = "NSString"
        ))]
        #[deprecated = "Use NSXPCConnection instead"]
        #[unsafe(method(rootProxyForConnectionWithRegisteredName:host:usingNameServer:))]
        #[unsafe(method_family = none)]
        pub fn rootProxyForConnectionWithRegisteredName_host_usingNameServer(
            name: &NSString,
            host_name: Option<&NSString>,
            server: &NSPortNameServer,
        ) -> Option<Retained<NSDistantObject>>;

        #[cfg(all(feature = "NSPortNameServer", feature = "NSString"))]
        /// # Safety
        ///
        /// `root` should be of the correct type.
        #[unsafe(method(serviceConnectionWithName:rootObject:usingNameServer:))]
        #[unsafe(method_family = none)]
        pub unsafe fn serviceConnectionWithName_rootObject_usingNameServer(
            name: &NSString,
            root: &AnyObject,
            server: &NSPortNameServer,
        ) -> Option<Retained<Self>>;

        #[cfg(feature = "NSString")]
        /// # Safety
        ///
        /// `root` should be of the correct type.
        #[unsafe(method(serviceConnectionWithName:rootObject:))]
        #[unsafe(method_family = none)]
        pub unsafe fn serviceConnectionWithName_rootObject(
            name: &NSString,
            root: &AnyObject,
        ) -> Option<Retained<Self>>;

        #[cfg(feature = "NSDate")]
        #[deprecated = "Use NSXPCConnection instead"]
        #[unsafe(method(requestTimeout))]
        #[unsafe(method_family = none)]
        pub fn requestTimeout(&self) -> NSTimeInterval;

        #[cfg(feature = "NSDate")]
        /// Setter for [`requestTimeout`][Self::requestTimeout].
        #[deprecated = "Use NSXPCConnection instead"]
        #[unsafe(method(setRequestTimeout:))]
        #[unsafe(method_family = none)]
        pub fn setRequestTimeout(&self, request_timeout: NSTimeInterval);

        #[cfg(feature = "NSDate")]
        #[deprecated = "Use NSXPCConnection instead"]
        #[unsafe(method(replyTimeout))]
        #[unsafe(method_family = none)]
        pub fn replyTimeout(&self) -> NSTimeInterval;

        #[cfg(feature = "NSDate")]
        /// Setter for [`replyTimeout`][Self::replyTimeout].
        #[deprecated = "Use NSXPCConnection instead"]
        #[unsafe(method(setReplyTimeout:))]
        #[unsafe(method_family = none)]
        pub fn setReplyTimeout(&self, reply_timeout: NSTimeInterval);

        #[deprecated = "Use NSXPCConnection instead"]
        #[unsafe(method(rootObject))]
        #[unsafe(method_family = none)]
        pub fn rootObject(&self) -> Option<Retained<AnyObject>>;

        /// Setter for [`rootObject`][Self::rootObject].
        ///
        /// # Safety
        ///
        /// `root_object` should be of the correct type.
        #[deprecated = "Use NSXPCConnection instead"]
        #[unsafe(method(setRootObject:))]
        #[unsafe(method_family = none)]
        pub unsafe fn setRootObject(&self, root_object: Option<&AnyObject>);

        /// # Safety
        ///
        /// This is not retained internally, you must ensure the object is still alive.
        #[deprecated = "Use NSXPCConnection instead"]
        #[unsafe(method(delegate))]
        #[unsafe(method_family = none)]
        pub unsafe fn delegate(&self)
            -> Option<Retained<ProtocolObject<dyn NSConnectionDelegate>>>;

        /// Setter for [`delegate`][Self::delegate].
        ///
        /// # Safety
        ///
        /// This is unretained, you must ensure the object is kept alive while in use.
        #[deprecated = "Use NSXPCConnection instead"]
        #[unsafe(method(setDelegate:))]
        #[unsafe(method_family = none)]
        pub unsafe fn setDelegate(
            &self,
            delegate: Option<&ProtocolObject<dyn NSConnectionDelegate>>,
        );

        #[deprecated = "Use NSXPCConnection instead"]
        #[unsafe(method(independentConversationQueueing))]
        #[unsafe(method_family = none)]
        pub fn independentConversationQueueing(&self) -> bool;

        /// Setter for [`independentConversationQueueing`][Self::independentConversationQueueing].
        #[deprecated = "Use NSXPCConnection instead"]
        #[unsafe(method(setIndependentConversationQueueing:))]
        #[unsafe(method_family = none)]
        pub fn setIndependentConversationQueueing(&self, independent_conversation_queueing: bool);

        #[deprecated = "Use NSXPCConnection instead"]
        #[unsafe(method(isValid))]
        #[unsafe(method_family = none)]
        pub fn isValid(&self) -> bool;

        #[cfg(all(feature = "NSDistantObject", feature = "NSProxy"))]
        #[deprecated = "Use NSXPCConnection instead"]
        #[unsafe(method(rootProxy))]
        #[unsafe(method_family = none)]
        pub fn rootProxy(&self) -> Retained<NSDistantObject>;

        #[deprecated = "Use NSXPCConnection instead"]
        #[unsafe(method(invalidate))]
        #[unsafe(method_family = none)]
        pub fn invalidate(&self);

        #[cfg(feature = "NSString")]
        #[deprecated = "Use NSXPCConnection instead"]
        #[unsafe(method(addRequestMode:))]
        #[unsafe(method_family = none)]
        pub fn addRequestMode(&self, rmode: &NSString);

        #[cfg(feature = "NSString")]
        #[deprecated = "Use NSXPCConnection instead"]
        #[unsafe(method(removeRequestMode:))]
        #[unsafe(method_family = none)]
        pub fn removeRequestMode(&self, rmode: &NSString);

        #[cfg(all(feature = "NSArray", feature = "NSString"))]
        #[deprecated = "Use NSXPCConnection instead"]
        #[unsafe(method(requestModes))]
        #[unsafe(method_family = none)]
        pub fn requestModes(&self) -> Retained<NSArray<NSString>>;

        #[cfg(feature = "NSString")]
        #[deprecated = "Use NSXPCConnection instead"]
        #[unsafe(method(registerName:))]
        #[unsafe(method_family = none)]
        pub fn registerName(&self, name: Option<&NSString>) -> bool;

        #[cfg(all(feature = "NSPortNameServer", feature = "NSString"))]
        #[deprecated = "Use NSXPCConnection instead"]
        #[unsafe(method(registerName:withNameServer:))]
        #[unsafe(method_family = none)]
        pub fn registerName_withNameServer(
            &self,
            name: Option<&NSString>,
            server: &NSPortNameServer,
        ) -> bool;

        #[cfg(feature = "NSPort")]
        #[deprecated = "Use NSXPCConnection instead"]
        #[unsafe(method(connectionWithReceivePort:sendPort:))]
        #[unsafe(method_family = none)]
        pub fn connectionWithReceivePort_sendPort(
            receive_port: Option<&NSPort>,
            send_port: Option<&NSPort>,
        ) -> Option<Retained<Self>>;

        #[deprecated = "Use NSXPCConnection instead"]
        #[unsafe(method(currentConversation))]
        #[unsafe(method_family = none)]
        pub fn currentConversation() -> Option<Retained<AnyObject>>;

        #[cfg(feature = "NSPort")]
        #[deprecated = "Use NSXPCConnection instead"]
        #[unsafe(method(initWithReceivePort:sendPort:))]
        #[unsafe(method_family = init)]
        pub fn initWithReceivePort_sendPort(
            this: Allocated<Self>,
            receive_port: Option<&NSPort>,
            send_port: Option<&NSPort>,
        ) -> Option<Retained<Self>>;

        #[cfg(feature = "NSPort")]
        #[deprecated = "Use NSXPCConnection instead"]
        #[unsafe(method(sendPort))]
        #[unsafe(method_family = none)]
        pub fn sendPort(&self) -> Retained<NSPort>;

        #[cfg(feature = "NSPort")]
        #[deprecated = "Use NSXPCConnection instead"]
        #[unsafe(method(receivePort))]
        #[unsafe(method_family = none)]
        pub fn receivePort(&self) -> Retained<NSPort>;

        #[deprecated = "Use NSXPCConnection instead"]
        #[unsafe(method(enableMultipleThreads))]
        #[unsafe(method_family = none)]
        pub fn enableMultipleThreads(&self);

        #[deprecated = "Use NSXPCConnection instead"]
        #[unsafe(method(multipleThreadsEnabled))]
        #[unsafe(method_family = none)]
        pub fn multipleThreadsEnabled(&self) -> bool;

        #[cfg(feature = "NSRunLoop")]
        /// # Safety
        ///
        /// `runloop` possibly has additional threading requirements.
        #[deprecated = "Use NSXPCConnection instead"]
        #[unsafe(method(addRunLoop:))]
        #[unsafe(method_family = none)]
        pub unsafe fn addRunLoop(&self, runloop: &NSRunLoop);

        #[cfg(feature = "NSRunLoop")]
        /// # Safety
        ///
        /// `runloop` possibly has additional threading requirements.
        #[deprecated = "Use NSXPCConnection instead"]
        #[unsafe(method(removeRunLoop:))]
        #[unsafe(method_family = none)]
        pub unsafe fn removeRunLoop(&self, runloop: &NSRunLoop);

        #[deprecated = "Use NSXPCConnection instead"]
        #[unsafe(method(runInNewThread))]
        #[unsafe(method_family = none)]
        pub fn runInNewThread(&self);

        #[cfg(feature = "NSArray")]
        #[deprecated = "Use NSXPCConnection instead"]
        #[unsafe(method(remoteObjects))]
        #[unsafe(method_family = none)]
        pub fn remoteObjects(&self) -> Retained<NSArray>;

        #[cfg(feature = "NSArray")]
        #[deprecated = "Use NSXPCConnection instead"]
        #[unsafe(method(localObjects))]
        #[unsafe(method_family = none)]
        pub fn localObjects(&self) -> Retained<NSArray>;

        #[cfg(feature = "NSArray")]
        /// # Safety
        ///
        /// `components` generic should be of the correct type.
        #[unsafe(method(dispatchWithComponents:))]
        #[unsafe(method_family = none)]
        pub unsafe fn dispatchWithComponents(&self, components: &NSArray);
    );
}

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

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

impl DefaultRetained for NSConnection {
    #[inline]
    fn default_retained() -> Retained<Self> {
        Self::new()
    }
}

extern "C" {
    /// [Apple's documentation](https://developer.apple.com/documentation/foundation/nsconnectionreplymode?language=objc)
    #[cfg(feature = "NSString")]
    #[deprecated = "Use NSXPCConnection instead"]
    pub static NSConnectionReplyMode: &'static NSString;
}

extern "C" {
    /// [Apple's documentation](https://developer.apple.com/documentation/foundation/nsconnectiondiddienotification?language=objc)
    #[cfg(feature = "NSString")]
    #[deprecated = "Use NSXPCConnection instead"]
    pub static NSConnectionDidDieNotification: &'static NSString;
}

extern_protocol!(
    /// [Apple's documentation](https://developer.apple.com/documentation/foundation/nsconnectiondelegate?language=objc)
    #[deprecated = "Use NSXPCConnection instead"]
    pub unsafe trait NSConnectionDelegate: NSObjectProtocol {
        #[deprecated = "Use NSXPCConnection instead"]
        #[optional]
        #[unsafe(method(makeNewConnection:sender:))]
        #[unsafe(method_family = none)]
        fn makeNewConnection_sender(&self, conn: &NSConnection, ancestor: &NSConnection) -> bool;

        #[deprecated = "Use NSXPCConnection instead"]
        #[optional]
        #[unsafe(method(connection:shouldMakeNewConnection:))]
        #[unsafe(method_family = none)]
        fn connection_shouldMakeNewConnection(
            &self,
            ancestor: &NSConnection,
            conn: &NSConnection,
        ) -> bool;

        #[cfg(all(feature = "NSArray", feature = "NSData"))]
        /// # Safety
        ///
        /// `components` generic should be of the correct type.
        #[deprecated = "Use NSXPCConnection instead"]
        #[optional]
        #[unsafe(method(authenticationDataForComponents:))]
        #[unsafe(method_family = none)]
        unsafe fn authenticationDataForComponents(&self, components: &NSArray) -> Retained<NSData>;

        #[cfg(all(feature = "NSArray", feature = "NSData"))]
        /// # Safety
        ///
        /// `components` generic should be of the correct type.
        #[deprecated = "Use NSXPCConnection instead"]
        #[optional]
        #[unsafe(method(authenticateComponents:withData:))]
        #[unsafe(method_family = none)]
        unsafe fn authenticateComponents_withData(
            &self,
            components: &NSArray,
            signature: &NSData,
        ) -> bool;

        #[deprecated = "Use NSXPCConnection instead"]
        #[optional]
        #[unsafe(method(createConversationForConnection:))]
        #[unsafe(method_family = none)]
        fn createConversationForConnection(&self, conn: &NSConnection) -> Retained<AnyObject>;

        #[deprecated = "Use NSXPCConnection instead"]
        #[optional]
        #[unsafe(method(connection:handleRequest:))]
        #[unsafe(method_family = none)]
        fn connection_handleRequest(
            &self,
            connection: &NSConnection,
            doreq: &NSDistantObjectRequest,
        ) -> bool;
    }
);

extern "C" {
    /// [Apple's documentation](https://developer.apple.com/documentation/foundation/nsfailedauthenticationexception?language=objc)
    #[cfg(feature = "NSString")]
    #[deprecated = "Use NSXPCConnection instead"]
    pub static NSFailedAuthenticationException: &'static NSString;
}

extern "C" {
    /// [Apple's documentation](https://developer.apple.com/documentation/foundation/nsconnectiondidinitializenotification?language=objc)
    #[cfg(feature = "NSString")]
    #[deprecated = "Use NSXPCConnection instead"]
    pub static NSConnectionDidInitializeNotification: &'static NSString;
}

extern_class!(
    /// [Apple's documentation](https://developer.apple.com/documentation/foundation/nsdistantobjectrequest?language=objc)
    #[unsafe(super(NSObject))]
    #[derive(Debug, PartialEq, Eq, Hash)]
    #[deprecated = "Use NSXPCConnection instead"]
    pub struct NSDistantObjectRequest;
);

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

impl NSDistantObjectRequest {
    extern_methods!(
        #[cfg(feature = "NSInvocation")]
        #[deprecated = "Use NSXPCConnection instead"]
        #[unsafe(method(invocation))]
        #[unsafe(method_family = none)]
        pub unsafe fn invocation(&self) -> Retained<NSInvocation>;

        #[deprecated = "Use NSXPCConnection instead"]
        #[unsafe(method(connection))]
        #[unsafe(method_family = none)]
        pub fn connection(&self) -> Retained<NSConnection>;

        #[deprecated = "Use NSXPCConnection instead"]
        #[unsafe(method(conversation))]
        #[unsafe(method_family = none)]
        pub fn conversation(&self) -> Retained<AnyObject>;

        #[cfg(feature = "NSException")]
        #[deprecated = "Use NSXPCConnection instead"]
        #[unsafe(method(replyWithException:))]
        #[unsafe(method_family = none)]
        pub fn replyWithException(&self, exception: Option<&NSException>);
    );
}

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

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

impl DefaultRetained for NSDistantObjectRequest {
    #[inline]
    fn default_retained() -> Retained<Self> {
        Self::new()
    }
}