systemconfiguration-rs 0.2.1

Safe Rust bindings for Apple's SystemConfiguration framework via a Swift bridge 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
use std::{
    ffi::c_void,
    sync::{Arc, Mutex},
};

use crate::{
    bridge::{self, CStringArray},
    error::Result,
    ffi,
    PropertyList, SystemConfigurationError,
};

struct CallbackState {
    callback: Box<dyn FnMut(Vec<String>) + Send>,
}

unsafe extern "C" fn dynamic_store_callback(changed_keys_raw: bridge::RawHandle, info: *mut c_void) {
    if info.is_null() {
        return;
    }

    let mutex = &*info.cast::<Mutex<CallbackState>>();
    if let Ok(mut state) = mutex.lock() {
        (state.callback)(bridge::take_string_array(changed_keys_raw));
    }
}

#[derive(Clone)]
pub struct DynamicStore {
    raw: bridge::OwnedHandle,
    _callback: Option<Arc<Mutex<CallbackState>>>,
}

impl std::fmt::Debug for DynamicStore {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("DynamicStore").finish_non_exhaustive()
    }
}

#[derive(Clone)]
pub struct DynamicStoreRunLoopSource {
    raw: bridge::OwnedHandle,
}

impl std::fmt::Debug for DynamicStoreRunLoopSource {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("DynamicStoreRunLoopSource").finish_non_exhaustive()
    }
}

impl DynamicStore {
    pub fn type_id() -> u64 {
        unsafe { ffi::dynamic_store::sc_dynamic_store_get_type_id() }
    }

    pub fn new(name: &str) -> Result<Self> {
        Self::create(name, false, None)
    }

    pub fn new_with_session_keys(name: &str) -> Result<Self> {
        Self::create(name, true, None)
    }

    pub fn new_with_callback<F>(name: &str, callback: F) -> Result<Self>
    where
        F: FnMut(Vec<String>) + Send + 'static,
    {
        let callback = Arc::new(Mutex::new(CallbackState {
            callback: Box::new(callback),
        }));
        Self::create(name, false, Some(callback))
    }

    pub fn new_with_session_keys_and_callback<F>(name: &str, callback: F) -> Result<Self>
    where
        F: FnMut(Vec<String>) + Send + 'static,
    {
        let callback = Arc::new(Mutex::new(CallbackState {
            callback: Box::new(callback),
        }));
        Self::create(name, true, Some(callback))
    }

    fn create(name: &str, use_session_keys: bool, callback: Option<Arc<Mutex<CallbackState>>>) -> Result<Self> {
        let name = bridge::cstring(name, "sc_dynamic_store_create")?;
        let raw = unsafe {
            callback.as_ref().map_or_else(
                || ffi::dynamic_store::sc_dynamic_store_create(name.as_ptr(), u8::from(use_session_keys)),
                |state| {
                    ffi::dynamic_store::sc_dynamic_store_create_with_callback(
                        name.as_ptr(),
                        u8::from(use_session_keys),
                        Some(dynamic_store_callback),
                        Arc::as_ptr(state).cast_mut().cast::<c_void>(),
                    )
                },
            )
        };
        let raw = bridge::owned_handle_or_last("sc_dynamic_store_create", raw)?;
        Ok(Self {
            raw,
            _callback: callback,
        })
    }

    pub fn copy_value(&self, key: &str) -> Result<Option<PropertyList>> {
        let key = bridge::cstring(key, "sc_dynamic_store_copy_value")?;
        let raw = unsafe { ffi::dynamic_store::sc_dynamic_store_copy_value(self.raw.as_ptr(), key.as_ptr()) };
        Ok(unsafe { bridge::OwnedHandle::from_raw(raw) }.map(PropertyList::from_owned_handle))
    }

    pub fn copy_multiple<K, P>(&self, keys: &[K], patterns: &[P]) -> Result<Option<PropertyList>>
    where
        K: AsRef<str>,
        P: AsRef<str>,
    {
        let keys = CStringArray::new(keys, "sc_dynamic_store_copy_multiple")?;
        let patterns = CStringArray::new(patterns, "sc_dynamic_store_copy_multiple")?;
        let raw = unsafe {
            ffi::dynamic_store::sc_dynamic_store_copy_multiple(
                self.raw.as_ptr(),
                keys.as_ptr(),
                keys.count(),
                patterns.as_ptr(),
                patterns.count(),
            )
        };
        Ok(unsafe { bridge::OwnedHandle::from_raw(raw) }.map(PropertyList::from_owned_handle))
    }

    pub fn add_value(&self, key: &str, value: &PropertyList) -> Result<()> {
        let key = bridge::cstring(key, "sc_dynamic_store_add_value")?;
        let ok = unsafe {
            ffi::dynamic_store::sc_dynamic_store_add_value(self.raw.as_ptr(), key.as_ptr(), value.as_ptr())
        };
        bridge::bool_result("sc_dynamic_store_add_value", ok)
    }

    pub fn add_temporary_value(&self, key: &str, value: &PropertyList) -> Result<()> {
        let key = bridge::cstring(key, "sc_dynamic_store_add_temporary_value")?;
        let ok = unsafe {
            ffi::dynamic_store::sc_dynamic_store_add_temporary_value(
                self.raw.as_ptr(),
                key.as_ptr(),
                value.as_ptr(),
            )
        };
        bridge::bool_result("sc_dynamic_store_add_temporary_value", ok)
    }

    pub fn set_value(&self, key: &str, value: &PropertyList) -> Result<()> {
        let key = bridge::cstring(key, "sc_dynamic_store_set_value")?;
        let ok = unsafe {
            ffi::dynamic_store::sc_dynamic_store_set_value(self.raw.as_ptr(), key.as_ptr(), value.as_ptr())
        };
        bridge::bool_result("sc_dynamic_store_set_value", ok)
    }

    pub fn set_multiple<R, N>(
        &self,
        keys_to_set: Option<&PropertyList>,
        keys_to_remove: &[R],
        keys_to_notify: &[N],
    ) -> Result<()>
    where
        R: AsRef<str>,
        N: AsRef<str>,
    {
        let keys_to_remove = CStringArray::new(keys_to_remove, "sc_dynamic_store_set_multiple")?;
        let keys_to_notify = CStringArray::new(keys_to_notify, "sc_dynamic_store_set_multiple")?;
        let ok = unsafe {
            ffi::dynamic_store::sc_dynamic_store_set_multiple(
                self.raw.as_ptr(),
                keys_to_set.map_or(std::ptr::null_mut(), PropertyList::as_ptr),
                keys_to_remove.as_ptr(),
                keys_to_remove.count(),
                keys_to_notify.as_ptr(),
                keys_to_notify.count(),
            )
        };
        bridge::bool_result("sc_dynamic_store_set_multiple", ok)
    }

    pub fn remove_value(&self, key: &str) -> Result<()> {
        let key = bridge::cstring(key, "sc_dynamic_store_remove_value")?;
        let ok = unsafe { ffi::dynamic_store::sc_dynamic_store_remove_value(self.raw.as_ptr(), key.as_ptr()) };
        bridge::bool_result("sc_dynamic_store_remove_value", ok)
    }

    pub fn notify_value(&self, key: &str) -> Result<()> {
        let key = bridge::cstring(key, "sc_dynamic_store_notify_value")?;
        let ok = unsafe { ffi::dynamic_store::sc_dynamic_store_notify_value(self.raw.as_ptr(), key.as_ptr()) };
        bridge::bool_result("sc_dynamic_store_notify_value", ok)
    }

    pub fn copy_key_list(&self, pattern: &str) -> Result<Vec<String>> {
        let pattern = bridge::cstring(pattern, "sc_dynamic_store_copy_key_list")?;
        let raw = unsafe { ffi::dynamic_store::sc_dynamic_store_copy_key_list(self.raw.as_ptr(), pattern.as_ptr()) };
        Ok(bridge::take_string_array(raw))
    }

    pub fn set_notification_keys<K, P>(&self, keys: &[K], patterns: &[P]) -> Result<()>
    where
        K: AsRef<str>,
        P: AsRef<str>,
    {
        let keys = CStringArray::new(keys, "sc_dynamic_store_set_notification_keys")?;
        let patterns = CStringArray::new(patterns, "sc_dynamic_store_set_notification_keys")?;
        let ok = unsafe {
            ffi::dynamic_store::sc_dynamic_store_set_notification_keys(
                self.raw.as_ptr(),
                keys.as_ptr(),
                keys.count(),
                patterns.as_ptr(),
                patterns.count(),
            )
        };
        bridge::bool_result("sc_dynamic_store_set_notification_keys", ok)
    }

    pub fn create_run_loop_source(&self, order: isize) -> Result<DynamicStoreRunLoopSource> {
        let raw = unsafe { ffi::dynamic_store::sc_dynamic_store_create_run_loop_source(self.raw.as_ptr(), order) };
        let raw = bridge::owned_handle_or_last("sc_dynamic_store_create_run_loop_source", raw)?;
        Ok(DynamicStoreRunLoopSource { raw })
    }

    pub fn set_dispatch_queue_global(&self) -> Result<()> {
        let ok = unsafe { ffi::dynamic_store::sc_dynamic_store_set_dispatch_queue_global(self.raw.as_ptr()) };
        bridge::bool_result("sc_dynamic_store_set_dispatch_queue_global", ok)
    }

    pub fn clear_dispatch_queue(&self) -> Result<()> {
        let ok = unsafe { ffi::dynamic_store::sc_dynamic_store_clear_dispatch_queue(self.raw.as_ptr()) };
        bridge::bool_result("sc_dynamic_store_clear_dispatch_queue", ok)
    }

    pub fn copy_notified_keys(&self) -> Vec<String> {
        let raw = unsafe { ffi::dynamic_store::sc_dynamic_store_copy_notified_keys(self.raw.as_ptr()) };
        bridge::take_string_array(raw)
    }

    pub fn computer_name(&self) -> Option<String> {
        bridge::take_optional_string(unsafe {
            ffi::dynamic_store::sc_dynamic_store_copy_computer_name(self.raw.as_ptr())
        })
    }

    pub fn local_host_name(&self) -> Option<String> {
        bridge::take_optional_string(unsafe {
            ffi::dynamic_store::sc_dynamic_store_copy_local_host_name(self.raw.as_ptr())
        })
    }

    pub fn location(&self) -> Option<String> {
        bridge::take_optional_string(unsafe {
            ffi::dynamic_store::sc_dynamic_store_copy_location(self.raw.as_ptr())
        })
    }

    pub fn proxies(&self) -> Option<PropertyList> {
        let raw = unsafe { ffi::dynamic_store::sc_dynamic_store_copy_proxies(self.raw.as_ptr()) };
        unsafe { bridge::OwnedHandle::from_raw(raw) }.map(PropertyList::from_owned_handle)
    }

    pub fn dhcp_info(&self, service_id: Option<&str>) -> Result<Option<PropertyList>> {
        let service_id = bridge::optional_cstring(service_id, "sc_dynamic_store_copy_dhcp_info")?;
        let raw = unsafe {
            ffi::dynamic_store::sc_dynamic_store_copy_dhcp_info(
                self.raw.as_ptr(),
                service_id.as_ref().map_or(std::ptr::null(), |value| value.as_ptr()),
            )
        };
        Ok(unsafe { bridge::OwnedHandle::from_raw(raw) }.map(PropertyList::from_owned_handle))
    }

    pub fn dhcp_option_data(info: &PropertyList, code: u8) -> Option<PropertyList> {
        unsafe { bridge::OwnedHandle::from_raw(ffi::dynamic_store::sc_dhcp_info_copy_option_data(info.as_ptr(), code)) }
            .map(PropertyList::from_owned_handle)
    }

    pub fn dhcp_lease_start_time(info: &PropertyList) -> Option<PropertyList> {
        unsafe { bridge::OwnedHandle::from_raw(ffi::dynamic_store::sc_dhcp_info_copy_lease_start_time(info.as_ptr())) }
            .map(PropertyList::from_owned_handle)
    }

    pub fn dhcp_lease_expiration_time(info: &PropertyList) -> Option<PropertyList> {
        unsafe {
            bridge::OwnedHandle::from_raw(ffi::dynamic_store::sc_dhcp_info_copy_lease_expiration_time(
                info.as_ptr(),
            ))
        }
        .map(PropertyList::from_owned_handle)
    }

    pub fn key_create<A: AsRef<str>>(format: &str, arguments: &[A]) -> Result<String> {
        let format = bridge::cstring(format, "sc_dynamic_store_key_create")?;
        let arguments = CStringArray::new(arguments, "sc_dynamic_store_key_create")?;
        bridge::take_optional_string(unsafe {
            ffi::dynamic_store::sc_dynamic_store_key_create(format.as_ptr(), arguments.as_ptr(), arguments.count())
        })
        .ok_or_else(|| {
            SystemConfigurationError::null(
                "sc_dynamic_store_key_create",
                "bridge returned null dynamic-store formatted key",
            )
        })
    }

    pub fn network_global_entity_key(domain: &str, entity: &str) -> Result<String> {
        let domain = bridge::cstring(domain, "sc_dynamic_store_key_create_network_global_entity")?;
        let entity = bridge::cstring(entity, "sc_dynamic_store_key_create_network_global_entity")?;
        bridge::take_optional_string(unsafe {
            ffi::dynamic_store::sc_dynamic_store_key_create_network_global_entity(
                domain.as_ptr(),
                entity.as_ptr(),
            )
        })
        .ok_or_else(|| {
            SystemConfigurationError::null(
                "sc_dynamic_store_key_create_network_global_entity",
                "bridge returned null dynamic-store global entity key",
            )
        })
    }

    pub fn network_interface_key(domain: &str) -> Result<String> {
        let domain = bridge::cstring(domain, "sc_dynamic_store_key_create_network_interface")?;
        bridge::take_optional_string(unsafe {
            ffi::dynamic_store::sc_dynamic_store_key_create_network_interface(domain.as_ptr())
        })
        .ok_or_else(|| {
            SystemConfigurationError::null(
                "sc_dynamic_store_key_create_network_interface",
                "bridge returned null dynamic-store interface key",
            )
        })
    }

    pub fn network_interface_entity_key(
        domain: &str,
        interface_name: &str,
        entity: Option<&str>,
    ) -> Result<String> {
        let domain = bridge::cstring(domain, "sc_dynamic_store_key_create_network_interface_entity")?;
        let interface_name = bridge::cstring(
            interface_name,
            "sc_dynamic_store_key_create_network_interface_entity",
        )?;
        let entity = bridge::optional_cstring(entity, "sc_dynamic_store_key_create_network_interface_entity")?;
        bridge::take_optional_string(unsafe {
            ffi::dynamic_store::sc_dynamic_store_key_create_network_interface_entity(
                domain.as_ptr(),
                interface_name.as_ptr(),
                entity.as_ref().map_or(std::ptr::null(), |value| value.as_ptr()),
            )
        })
        .ok_or_else(|| {
            SystemConfigurationError::null(
                "sc_dynamic_store_key_create_network_interface_entity",
                "bridge returned null dynamic-store interface-entity key",
            )
        })
    }

    pub fn network_service_entity_key(
        domain: &str,
        service_id: &str,
        entity: Option<&str>,
    ) -> Result<String> {
        let domain = bridge::cstring(domain, "sc_dynamic_store_key_create_network_service_entity")?;
        let service_id = bridge::cstring(service_id, "sc_dynamic_store_key_create_network_service_entity")?;
        let entity = bridge::optional_cstring(entity, "sc_dynamic_store_key_create_network_service_entity")?;
        bridge::take_optional_string(unsafe {
            ffi::dynamic_store::sc_dynamic_store_key_create_network_service_entity(
                domain.as_ptr(),
                service_id.as_ptr(),
                entity.as_ref().map_or(std::ptr::null(), |value| value.as_ptr()),
            )
        })
        .ok_or_else(|| {
            SystemConfigurationError::null(
                "sc_dynamic_store_key_create_network_service_entity",
                "bridge returned null dynamic-store service-entity key",
            )
        })
    }

    pub fn computer_name_key() -> Result<String> {
        bridge::take_optional_string(unsafe { ffi::dynamic_store::sc_dynamic_store_key_create_computer_name() })
            .ok_or_else(|| {
                SystemConfigurationError::null(
                    "sc_dynamic_store_key_create_computer_name",
                    "bridge returned null computer-name notification key",
                )
            })
    }

    pub fn console_user_key() -> Result<String> {
        bridge::take_optional_string(unsafe { ffi::dynamic_store::sc_dynamic_store_key_create_console_user() })
            .ok_or_else(|| {
                SystemConfigurationError::null(
                    "sc_dynamic_store_key_create_console_user",
                    "bridge returned null console-user notification key",
                )
            })
    }

    pub fn host_names_key() -> Result<String> {
        bridge::take_optional_string(unsafe { ffi::dynamic_store::sc_dynamic_store_key_create_host_names() })
            .ok_or_else(|| {
                SystemConfigurationError::null(
                    "sc_dynamic_store_key_create_host_names",
                    "bridge returned null host-names notification key",
                )
            })
    }

    pub fn location_key() -> Result<String> {
        bridge::take_optional_string(unsafe { ffi::dynamic_store::sc_dynamic_store_key_create_location() })
            .ok_or_else(|| {
                SystemConfigurationError::null(
                    "sc_dynamic_store_key_create_location",
                    "bridge returned null location notification key",
                )
            })
    }

    pub fn proxies_key() -> Result<String> {
        bridge::take_optional_string(unsafe { ffi::dynamic_store::sc_dynamic_store_key_create_proxies() })
            .ok_or_else(|| {
                SystemConfigurationError::null(
                    "sc_dynamic_store_key_create_proxies",
                    "bridge returned null proxies notification key",
                )
            })
    }

}

impl DynamicStoreRunLoopSource {
    pub fn schedule_current_default_mode(&self) -> Result<()> {
        let ok = unsafe { ffi::dynamic_store::sc_run_loop_source_schedule_current_default_mode(self.raw.as_ptr()) };
        bridge::bool_result("sc_run_loop_source_schedule_current_default_mode", ok)
    }

    pub fn unschedule_current_default_mode(&self) -> Result<()> {
        let ok = unsafe {
            ffi::dynamic_store::sc_run_loop_source_unschedule_current_default_mode(self.raw.as_ptr())
        };
        bridge::bool_result("sc_run_loop_source_unschedule_current_default_mode", ok)
    }
}