systemconfiguration-rs 0.5.3

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

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

#[derive(Clone)]
/// Wraps `SCVLANInterfaceRef`.
pub struct VlanInterface {
    raw: bridge::OwnedHandle,
}

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

impl VlanInterface {
    /// Wraps `SCVLANInterfaceCopyAll`.
    pub fn copy_all(preferences: &Preferences) -> Vec<Self> {
        let raw =
            unsafe { ffi::network_interface::sc_vlan_interface_copy_all(preferences.as_ptr()) };
        bridge::take_handle_array(raw, Self::from_owned_handle)
    }

    /// Wraps `SCVLANInterfaceCopyAvailablePhysicalInterfaces`.
    pub fn copy_available_physical_interfaces() -> Vec<NetworkInterface> {
        let raw = unsafe {
            ffi::network_interface::sc_vlan_interface_copy_available_physical_interfaces()
        };
        bridge::take_handle_array(raw, NetworkInterface::from_owned_handle)
    }

    /// Wraps `SCVLANInterfaceCreate`.
    pub fn create(
        preferences: &Preferences,
        physical: &NetworkInterface,
        tag: i32,
    ) -> Result<Self> {
        let raw = unsafe {
            ffi::network_interface::sc_vlan_interface_create(
                preferences.as_ptr(),
                physical.as_ptr(),
                tag,
            )
        };
        let raw = bridge::owned_handle_or_last("sc_vlan_interface_create", raw)?;
        Ok(Self { raw })
    }

    /// Wraps `SCVLANInterfaceCopyOptions`.
    pub fn options(&self) -> Option<PropertyList> {
        unsafe {
            bridge::OwnedHandle::from_raw(ffi::network_interface::sc_vlan_interface_copy_options(
                self.raw.as_ptr(),
            ))
        }
        .map(PropertyList::from_owned_handle)
    }

    /// Wraps `SCVLANInterfaceCopyPhysicalInterface`.
    pub fn physical_interface(&self) -> Option<NetworkInterface> {
        unsafe {
            bridge::OwnedHandle::from_raw(
                ffi::network_interface::sc_vlan_interface_copy_physical_interface(
                    self.raw.as_ptr(),
                ),
            )
        }
        .map(NetworkInterface::from_owned_handle)
    }

    /// Wraps `SCVLANInterfaceGetTag`.
    pub fn tag(&self) -> Result<Option<i32>> {
        let mut tag = 0_i32;
        let ok = unsafe {
            ffi::network_interface::sc_vlan_interface_get_tag(self.raw.as_ptr(), &mut tag)
        };
        if ok == 0 {
            return Ok(None);
        }
        Ok(Some(tag))
    }

    /// Wraps `SCVLANInterfaceRemove`.
    pub fn remove(&self) -> Result<()> {
        let ok = unsafe { ffi::network_interface::sc_vlan_interface_remove(self.raw.as_ptr()) };
        bridge::bool_result("sc_vlan_interface_remove", ok)
    }

    /// Wraps `SCVLANInterfaceSetLocalizedDisplayName`.
    pub fn set_localized_display_name(&self, name: &str) -> Result<()> {
        let name = bridge::cstring(name, "sc_vlan_interface_set_localized_display_name")?;
        let ok = unsafe {
            ffi::network_interface::sc_vlan_interface_set_localized_display_name(
                self.raw.as_ptr(),
                name.as_ptr(),
            )
        };
        bridge::bool_result("sc_vlan_interface_set_localized_display_name", ok)
    }

    /// Wraps `SCVLANInterfaceSetOptions`.
    pub fn set_options(&self, options: &PropertyList) -> Result<()> {
        let ok = unsafe {
            ffi::network_interface::sc_vlan_interface_set_options(
                self.raw.as_ptr(),
                options.as_ptr(),
            )
        };
        bridge::bool_result("sc_vlan_interface_set_options", ok)
    }

    /// Wraps `SCVLANInterfaceSetPhysicalInterfaceAndTag`.
    pub fn set_physical_interface_and_tag(
        &self,
        physical: &NetworkInterface,
        tag: i32,
    ) -> Result<()> {
        let ok = unsafe {
            ffi::network_interface::sc_vlan_interface_set_physical_interface_and_tag(
                self.raw.as_ptr(),
                physical.as_ptr(),
                tag,
            )
        };
        bridge::bool_result("sc_vlan_interface_set_physical_interface_and_tag", ok)
    }

    /// Wraps a helper on `SCVLANInterfaceRef`.
    pub fn as_network_interface(&self) -> NetworkInterface {
        NetworkInterface::from_owned_handle(self.raw.clone())
    }

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