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

use crate::{
    bridge,
    error::Result,
    ffi,
    network_interface::NetworkInterface,
    network_protocol::NetworkProtocol,
    preferences::Preferences,
};

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

impl NetworkService {
    pub fn type_id() -> u64 {
        unsafe { ffi::network_services::sc_network_service_get_type_id() }
    }

    pub fn copy_all(preferences: &Preferences) -> Vec<Self> {
        let raw = unsafe { ffi::network_services::sc_network_service_copy_all(preferences.as_ptr()) };
        bridge::take_handle_array(raw, Self::from_owned_handle)
    }

    pub fn create(preferences: &Preferences, interface: &NetworkInterface) -> Result<Self> {
        let raw = unsafe {
            ffi::network_services::sc_network_service_create(preferences.as_ptr(), interface.as_ptr())
        };
        let raw = bridge::owned_handle_or_last("sc_network_service_create", raw)?;
        Ok(Self { raw })
    }

    pub fn copy(preferences: &Preferences, service_id: &str) -> Result<Option<Self>> {
        let service_id = bridge::cstring(service_id, "sc_network_service_copy")?;
        let raw = unsafe {
            ffi::network_services::sc_network_service_copy(preferences.as_ptr(), service_id.as_ptr())
        };
        Ok(unsafe { bridge::OwnedHandle::from_raw(raw) }.map(Self::from_owned_handle))
    }

    pub fn copy_protocols(&self) -> Vec<NetworkProtocol> {
        let raw = unsafe { ffi::network_services::sc_network_service_copy_protocols(self.raw.as_ptr()) };
        bridge::take_handle_array(raw, NetworkProtocol::from_owned_handle)
    }

    pub fn copy_protocol(&self, protocol_type: &str) -> Result<Option<NetworkProtocol>> {
        let protocol_type = bridge::cstring(protocol_type, "sc_network_service_copy_protocol")?;
        let raw = unsafe {
            ffi::network_services::sc_network_service_copy_protocol(self.raw.as_ptr(), protocol_type.as_ptr())
        };
        Ok(unsafe { bridge::OwnedHandle::from_raw(raw) }.map(NetworkProtocol::from_owned_handle))
    }

    pub fn add_protocol_type(&self, protocol_type: &str) -> Result<()> {
        let protocol_type = bridge::cstring(protocol_type, "sc_network_service_add_protocol_type")?;
        let ok = unsafe {
            ffi::network_services::sc_network_service_add_protocol_type(self.raw.as_ptr(), protocol_type.as_ptr())
        };
        bridge::bool_result("sc_network_service_add_protocol_type", ok)
    }

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

    pub fn is_enabled(&self) -> bool {
        unsafe { ffi::network_services::sc_network_service_get_enabled(self.raw.as_ptr()) != 0 }
    }

    pub fn interface(&self) -> Option<NetworkInterface> {
        unsafe {
            bridge::OwnedHandle::from_raw(ffi::network_services::sc_network_service_copy_interface(
                self.raw.as_ptr(),
            ))
        }
        .map(NetworkInterface::from_owned_handle)
    }

    pub fn name(&self) -> Result<Option<String>> {
        Ok(bridge::take_optional_string(unsafe {
            ffi::network_services::sc_network_service_copy_name(self.raw.as_ptr())
        }))
    }

    pub fn service_id(&self) -> Result<Option<String>> {
        Ok(bridge::take_optional_string(unsafe {
            ffi::network_services::sc_network_service_copy_service_id(self.raw.as_ptr())
        }))
    }

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

    pub fn remove_protocol_type(&self, protocol_type: &str) -> Result<()> {
        let protocol_type = bridge::cstring(protocol_type, "sc_network_service_remove_protocol_type")?;
        let ok = unsafe {
            ffi::network_services::sc_network_service_remove_protocol_type(
                self.raw.as_ptr(),
                protocol_type.as_ptr(),
            )
        };
        bridge::bool_result("sc_network_service_remove_protocol_type", ok)
    }

    pub fn set_enabled(&self, enabled: bool) -> Result<()> {
        let ok = unsafe {
            ffi::network_services::sc_network_service_set_enabled(self.raw.as_ptr(), u8::from(enabled))
        };
        bridge::bool_result("sc_network_service_set_enabled", ok)
    }

    pub fn set_name(&self, name: Option<&str>) -> Result<()> {
        let name = bridge::optional_cstring(name, "sc_network_service_set_name")?;
        let ok = unsafe {
            ffi::network_services::sc_network_service_set_name(
                self.raw.as_ptr(),
                name.as_ref().map_or(std::ptr::null(), |value| value.as_ptr()),
            )
        };
        bridge::bool_result("sc_network_service_set_name", ok)
    }

    pub(crate) fn from_owned_handle(raw: bridge::OwnedHandle) -> Self {
        Self { raw }
    }

    pub(crate) fn as_ptr(&self) -> bridge::RawHandle {
        self.raw.as_ptr()
    }
}