cidre 0.14.0

Apple frameworks bindings for rust
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
use crate::{api, arc, blocks, define_obj_type, ns, nw};

define_obj_type!(
    #[doc(alias = "nw_parameters")]
    #[doc(alias = "nw_parameters_t")]
    pub Params(ns::Id)
);

unsafe impl Send for Params {}
unsafe impl Sync for Params {}

#[doc(alias = "nw_parameters_configure_protocol_block_t")]
pub type ParamsCfgProtocolBlock = blocks::SyncBlock<fn(options: &mut nw::ProtocolOpts)>;

impl Params {
    #[doc(alias = "nw_parameters_create")]
    #[inline]
    pub fn new() -> arc::R<Self> {
        unsafe { nw_parameters_create() }
    }

    #[doc(alias = "nw_parameters_copy")]
    #[inline]
    pub fn copy(&self) -> Option<arc::R<Self>> {
        unsafe { nw_parameters_copy(self) }
    }

    #[doc(alias = "nw_parameters_create_secure_tcp")]
    #[inline]
    pub fn secure_tcp(
        configure_tls: &mut ParamsCfgProtocolBlock,
        configure_tcp: &mut ParamsCfgProtocolBlock,
    ) -> Option<arc::R<Self>> {
        unsafe { nw_parameters_create_secure_tcp(configure_tls, configure_tcp) }
    }

    #[inline]
    pub fn default_tcp() -> arc::R<Self> {
        let cfg1 = Self::default_cfg();
        let cfg2 = Self::default_cfg();
        unsafe { Self::secure_tcp(cfg1, cfg2).unwrap_unchecked() }
    }

    #[doc(alias = "nw_parameters_create_secure_udp")]
    #[inline]
    pub fn secure_udp(
        configure_dtls: &mut ParamsCfgProtocolBlock,
        configure_udp: &mut ParamsCfgProtocolBlock,
    ) -> Option<arc::R<Self>> {
        unsafe { nw_parameters_create_secure_udp(configure_dtls, configure_udp) }
    }

    #[inline]
    pub fn udp() -> Option<arc::R<Self>> {
        unsafe {
            nw_parameters_create_secure_udp(
                nw::Params::disable_protocol(),
                nw::Params::default_cfg(),
            )
        }
    }

    #[inline]
    pub fn tcp() -> Option<arc::R<Self>> {
        unsafe {
            nw_parameters_create_secure_tcp(
                nw::Params::disable_protocol(),
                nw::Params::default_cfg(),
            )
        }
    }

    #[doc(alias = "nw_parameters_create_custom_ip")]
    #[inline]
    pub fn secure_custom_ip(
        custom_ip_protocol_number: u32,
        configure_ip: &mut ParamsCfgProtocolBlock,
    ) -> Option<arc::R<Self>> {
        unsafe { nw_parameters_create_custom_ip(custom_ip_protocol_number, configure_ip) }
    }

    #[doc(alias = "nw_parameters_create_quic")]
    #[inline]
    pub fn quic(configure_quic: &mut ParamsCfgProtocolBlock) -> Option<arc::R<Self>> {
        unsafe { nw_parameters_create_quic(configure_quic) }
    }

    #[doc(alias = "nw_parameters_create_application_service")]
    #[inline]
    pub fn app_service() -> arc::R<Self> {
        unsafe { nw_parameters_create_application_service() }
    }

    #[doc(alias = "NW_PARAMETERS_DEFAULT_CONFIGURATION")]
    #[inline]
    pub fn default_cfg() -> &'static mut ParamsCfgProtocolBlock {
        unsafe { _nw_parameters_configure_protocol_default_configuration }
    }

    #[doc(alias = "NW_PARAMETERS_DISABLE_PROTOCOL")]
    #[inline]
    pub fn disable_protocol() -> &'static mut ParamsCfgProtocolBlock {
        unsafe { _nw_parameters_configure_protocol_disable }
    }
}

#[cfg(feature = "blocks")]
pub type IterIfaceBlock = crate::blocks::NoEscBlock<fn(iface: &nw::Iface) -> bool>;

#[cfg(feature = "blocks")]
pub type IterIfaceTypeBlock = crate::blocks::NoEscBlock<fn(iface_type: nw::IfaceType) -> bool>;

/// Path Selection
impl Params {
    /// Require any connections or listeners using these parameters to use
    /// the provided network interface, or none if None is passed.
    #[doc(alias = "nw_parameters_require_interface")]
    pub fn set_required_iface(&mut self, iface: Option<&nw::Iface>) {
        unsafe {
            nw_parameters_require_interface(self, iface);
        }
    }

    #[doc(alias = "nw_parameters_copy_required_interface")]
    #[inline]
    pub fn required_iface(&self) -> Option<arc::R<nw::Iface>> {
        unsafe { nw_parameters_copy_required_interface(self) }
    }

    #[doc(alias = "nw_parameters_prohibit_interface")]
    #[inline]
    pub fn prohibit_iface(&mut self, iface: &nw::Iface) {
        unsafe { nw_parameters_prohibit_interface(self, iface) }
    }

    #[doc(alias = "nw_parameters_clear_prohibited_interfaces")]
    #[inline]
    pub fn clear_prohibit_ifaces(&mut self) {
        unsafe { nw_parameters_clear_prohibited_interfaces(self) }
    }

    #[cfg(feature = "blocks")]
    #[doc(alias = "nw_parameters_iterate_prohibited_interfaces")]
    #[inline]
    pub fn iterate_prohibit_ifaces_block(&self, block: &mut IterIfaceBlock) {
        unsafe {
            nw_parameters_iterate_prohibited_interfaces(self, block);
        }
    }

    #[cfg(feature = "blocks")]
    #[doc(alias = "nw_parameters_iterate_prohibited_interfaces")]
    #[inline]
    pub fn iterate_prohibit_ifaces(&self, mut f: impl FnMut(&nw::Iface) -> bool) {
        let mut block = unsafe { IterIfaceBlock::stack1(&mut f) };
        self.iterate_prohibit_ifaces_block(&mut block);
    }

    #[doc(alias = "nw_parameters_set_required_interface_type")]
    #[inline]
    pub fn set_required_iface_type(&mut self, val: nw::IfaceType) {
        unsafe {
            nw_parameters_set_required_interface_type(self, val);
        }
    }

    #[doc(alias = "nw_parameters_get_required_interface_type")]
    #[inline]
    pub fn required_iface_type(&self) -> nw::IfaceType {
        unsafe { nw_parameters_get_required_interface_type(self) }
    }

    #[doc(alias = "nw_parameters_prohibit_interface_type")]
    #[inline]
    pub fn prohibit_iface_type(&mut self, val: nw::IfaceType) {
        unsafe {
            nw_parameters_prohibit_interface_type(self, val);
        }
    }

    #[doc(alias = "nw_parameters_clear_prohibited_interface_types")]
    #[inline]
    pub fn clear_prohibited_iface_types(&mut self) {
        unsafe { nw_parameters_clear_prohibited_interface_types(self) }
    }

    #[cfg(feature = "blocks")]
    #[doc(alias = "nw_parameters_iterate_prohibited_interface_types")]
    #[inline]
    pub fn iterate_prohibit_iface_types_block(&self, block: &mut IterIfaceTypeBlock) {
        unsafe {
            nw_parameters_iterate_prohibited_interface_types(self, block);
        }
    }

    #[cfg(feature = "blocks")]
    #[doc(alias = "nw_parameters_iterate_prohibited_interface_types")]
    #[inline]
    pub fn iterate_prohibit_iface_types(&self, mut f: impl FnMut(nw::IfaceType) -> bool) {
        let mut block = unsafe { IterIfaceTypeBlock::stack1(&mut f) };
        self.iterate_prohibit_iface_types_block(&mut block);
    }

    #[doc(alias = "nw_parameters_set_prohibit_expensive")]
    #[inline]
    pub fn set_prohibit_expensive(&mut self, val: bool) {
        unsafe {
            nw_parameters_set_prohibit_expensive(self, val);
        }
    }

    /// Returns true if expensive interfaces are prohibited, or
    /// false otherwise.
    #[doc(alias = "nw_parameters_get_prohibit_expensive")]
    #[inline]
    pub fn prohibit_expensive(&self) -> bool {
        unsafe { nw_parameters_get_prohibit_expensive(self) }
    }

    #[doc(alias = "nw_parameters_get_prohibit_constrained")]
    #[inline]
    pub fn prohibit_constrained(&self) -> bool {
        unsafe { nw_parameters_get_prohibit_constrained(self) }
    }

    #[doc(alias = "nw_parameters_set_prohibit_constrained")]
    #[inline]
    pub fn set_prohibit_constrained(&mut self, val: bool) {
        unsafe { nw_parameters_set_prohibit_constrained(self, val) }
    }

    #[doc(alias = "nw_parameters_get_allow_ultra_constrained")]
    #[api::available(macos = 26.0, ios = 26.0, watchos = 26.0, tvos = 26.0, visionos = 26.0)]
    pub fn allow_ultra_constrained(&mut self) -> bool {
        unsafe { nw_parameters_get_allow_ultra_constrained(self) }
    }
    #[doc(alias = "nw_parameters_set_allow_ultra_constrained")]
    #[api::available(macos = 26.0, ios = 26.0, watchos = 26.0, tvos = 26.0, visionos = 26.0)]
    pub fn set_allow_ultra_constrained(&mut self, val: bool) {
        unsafe { nw_parameters_set_allow_ultra_constrained(self, val) }
    }

    #[doc(alias = "nw_parameters_get_reuse_local_address")]
    pub fn reuse_local_address(&self) -> bool {
        unsafe { nw_parameters_get_reuse_local_address(self) }
    }

    #[doc(alias = "nw_parameters_set_reuse_local_address")]
    #[inline]
    pub fn set_reuse_local_address(&mut self, val: bool) {
        unsafe { nw_parameters_set_reuse_local_address(self, val) }
    }

    #[doc(alias = "nw_parameters_copy_local_endpoint")]
    #[inline]
    pub fn local_endpoint(&self) -> Option<arc::Retained<nw::Endpoint>> {
        unsafe { nw_parameters_copy_local_endpoint(self) }
    }

    #[doc(alias = "nw_parameters_set_local_endpoint")]
    #[inline]
    pub fn set_local_endpoint(&mut self, val: Option<&nw::Endpoint>) {
        unsafe { nw_parameters_set_local_endpoint(self, val) }
    }

    #[doc(alias = "nw_parameters_get_include_peer_to_peer")]
    #[inline]
    pub fn include_peer_to_peer(&self) -> bool {
        unsafe { nw_parameters_get_include_peer_to_peer(self) }
    }

    #[doc(alias = "nw_parameters_set_include_peer_to_peer")]
    #[inline]
    pub fn set_include_peer_to_peer(&mut self, val: bool) {
        unsafe {
            nw_parameters_set_include_peer_to_peer(self, val);
        }
    }
}

/// The network service class represents the network queuing priority to use
/// for traffic generated by a connection.
#[doc(alias = "nw_service_class_t")]
#[derive(Debug, Copy, Clone, Eq, PartialEq, Default)]
#[repr(i32)]
pub enum ServiceClass {
    #[doc(alias = "nw_service_class_best_effort")]
    #[default]
    BestEffort = 0,
    #[doc(alias = "nw_service_class_background")]
    Background = 1,
    #[doc(alias = "nw_service_class_interactive_video")]
    InteractiveVideo = 2,
    #[doc(alias = "nw_service_class_interactive_voice")]
    InteractiveVoice = 3,
    #[doc(alias = "nw_service_class_responsive_data")]
    ResponsiveData = 4,
    #[doc(alias = "nw_service_class_signaling")]
    Signaling = 5,
}

#[doc(alias = "nw_multipath_service_t")]
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
#[repr(i32)]
pub enum MultipathService {
    Disabled = 0,
    Handover = 1,
    Interactive = 2,
    Aggregate = 3,
}

/// Data Handling
impl Params {
    #[doc(alias = "nw_parameters_get_fast_open_enabled")]
    #[inline]
    pub fn fast_open_enabled(&self) -> bool {
        unsafe { nw_parameters_get_fast_open_enabled(self) }
    }

    #[doc(alias = "nw_parameters_set_fast_open_enabled")]
    #[inline]
    pub fn set_fast_open_enabled(&mut self, val: bool) {
        unsafe {
            nw_parameters_set_fast_open_enabled(self, val);
        }
    }
}

define_obj_type!(
    #[doc(alias = "nw_protocol_stack")]
    #[doc(alias = "nw_protocol_stack_t")]
    pub ProtocolStack(ns::Id)
);

#[link(name = "Network", kind = "framework")]
#[api::weak]
unsafe extern "C-unwind" {
    fn nw_parameters_create() -> arc::R<Params>;
    fn nw_parameters_copy(params: &Params) -> Option<arc::R<Params>>;

    fn nw_parameters_create_secure_tcp(
        configure_tls: &mut ParamsCfgProtocolBlock,
        configure_tcp: &mut ParamsCfgProtocolBlock,
    ) -> Option<arc::R<Params>>;

    fn nw_parameters_create_secure_udp(
        configure_dtls: &mut ParamsCfgProtocolBlock,
        configure_udp: &mut ParamsCfgProtocolBlock,
    ) -> Option<arc::R<Params>>;

    fn nw_parameters_create_custom_ip(
        custom_ip_protocol_number: u32,
        configure_ip: &mut ParamsCfgProtocolBlock,
    ) -> Option<arc::R<Params>>;

    fn nw_parameters_create_quic(
        configure_quic: &mut ParamsCfgProtocolBlock,
    ) -> Option<arc::R<Params>>;

    fn nw_parameters_create_application_service() -> arc::R<Params>;

    fn nw_parameters_require_interface(params: &mut Params, iface: Option<&nw::Iface>);
    fn nw_parameters_copy_required_interface(params: &Params) -> Option<arc::R<nw::Iface>>;
    fn nw_parameters_prohibit_interface(params: &mut Params, iface: &nw::Iface);
    fn nw_parameters_clear_prohibited_interfaces(params: &mut Params);
    #[cfg(feature = "blocks")]
    fn nw_parameters_iterate_prohibited_interfaces(params: &Params, block: &mut IterIfaceBlock);
    fn nw_parameters_set_required_interface_type(params: &mut Params, val: nw::IfaceType);
    fn nw_parameters_get_required_interface_type(params: &Params) -> nw::IfaceType;
    fn nw_parameters_prohibit_interface_type(params: &mut Params, val: nw::IfaceType);
    fn nw_parameters_clear_prohibited_interface_types(params: &mut Params);
    #[cfg(feature = "blocks")]
    fn nw_parameters_iterate_prohibited_interface_types(
        params: &Params,
        block: &mut IterIfaceTypeBlock,
    );

    fn nw_parameters_set_prohibit_expensive(params: &mut Params, prohibit_expensive: bool);

    fn nw_parameters_get_prohibit_expensive(params: &Params) -> bool;

    fn nw_parameters_set_prohibit_constrained(params: &mut Params, prohibit_constrained: bool);
    fn nw_parameters_get_prohibit_constrained(params: &Params) -> bool;

    #[api::available(macos = 26.0, ios = 26.0, watchos = 26.0, tvos = 26.0, visionos = 26.0)]
    fn nw_parameters_set_allow_ultra_constrained(
        params: &mut Params,
        allow_ultra_constrained: bool,
    );

    #[api::available(macos = 26.0, ios = 26.0, watchos = 26.0, tvos = 26.0, visionos = 26.0)]
    fn nw_parameters_get_allow_ultra_constrained(params: &Params) -> bool;

    fn nw_parameters_set_reuse_local_address(params: &mut Params, val: bool);
    fn nw_parameters_get_reuse_local_address(params: &Params) -> bool;

    fn nw_parameters_set_local_endpoint(params: &mut Params, val: Option<&nw::Endpoint>);
    fn nw_parameters_copy_local_endpoint(params: &Params) -> Option<arc::R<nw::Endpoint>>;

    fn nw_parameters_set_include_peer_to_peer(params: &mut Params, val: bool);
    fn nw_parameters_get_include_peer_to_peer(params: &Params) -> bool;

    fn nw_parameters_set_fast_open_enabled(params: &mut Params, val: bool);
    fn nw_parameters_get_fast_open_enabled(params: &Params) -> bool;

    static mut _nw_parameters_configure_protocol_default_configuration:
        &'static mut ParamsCfgProtocolBlock;
    static mut _nw_parameters_configure_protocol_disable: &'static mut ParamsCfgProtocolBlock;
}

#[cfg(test)]
mod tests {
    use crate::{nw, objc::Obj};

    struct Dr(Vec<u8>);

    impl Drop for Dr {
        fn drop(&mut self) {
            eprintln!("Dropping");
        }
    }

    #[test]
    fn basics() {
        let params =
            nw::Params::secure_tcp(nw::Params::default_cfg(), nw::Params::default_cfg()).unwrap();
        eprintln!("{:?}", params.debug_desc());

        let mut x = Dr(vec![]);
        {
            let mut b = nw::ParamsCfgProtocolBlock::new1(move |opts| {
                x.0.push(1);
                eprintln!("{:?}----------> {:?}", x.0, opts);
            });
            let params = nw::Params::quic(&mut b).unwrap();
            eprintln!("{:?}", params.debug_desc());
        }
        eprintln!("{:?}", nw::Params::default_cfg().debug_desc());
        eprintln!("{:?}", nw::Params::disable_protocol().debug_desc());

        let _ = nw::Params::tcp().unwrap();
    }

    #[test]
    fn paths() {
        let udp_params = nw::Params::udp().unwrap();
        let mut n = 0;
        udp_params.iterate_prohibit_ifaces(|_iface| {
            n += 1;
            true
        });

        assert_eq!(n, 0);
    }
}