corewlan 0.2.0

Safe Rust bindings for Apple's CoreWLAN framework — inspect Wi-Fi interfaces, mutable configurations, event delegates, and preferred network state 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

//! `CWMutableNetworkProfile` wrapper.

use crate::{
    error::CoreWlanError,
    network_profile::NetworkProfile,
    security::Security,
};
use std::ops::Deref;

#[derive(Debug, Clone)]
pub struct MutableNetworkProfile {
    base: NetworkProfile,
}

impl MutableNetworkProfile {
    /// # Errors
    ///
    /// Returns an error if the framework unexpectedly returns `nil`.
    pub fn new() -> crate::Result<Self> {
        unsafe {
            NetworkProfile::from_owned_raw(crate::ffi::cwrs_mutable_network_profile_new())
                .map(|base| Self { base })
                .ok_or(CoreWlanError::UnexpectedNull(
                    "[[CWMutableNetworkProfile alloc] init]",
                ))
        }
    }

    /// # Errors
    ///
    /// Returns an error if creating the mutable copy unexpectedly yields `nil`.
    pub fn from_network_profile(profile: &NetworkProfile) -> crate::Result<Self> {
        unsafe {
            NetworkProfile::from_owned_raw(
                crate::ffi::cwrs_mutable_network_profile_with_network_profile(profile.as_raw()),
            )
            .map(|base| Self { base })
            .ok_or(CoreWlanError::UnexpectedNull("[CWNetworkProfile mutableCopy]"))
        }
    }

    pub(crate) const fn as_raw(&self) -> crate::ffi::Object {
        self.base.as_raw()
    }

    pub fn set_ssid_data(&self, ssid: Option<&[u8]>) {
        let (ptr, len) = crate::object::optional_ptr(ssid);
        unsafe {
            crate::ffi::cwrs_mutable_network_profile_set_ssid_data(self.as_raw(), ptr, len);
        }
    }

    pub fn set_security(&self, security: Security) {
        unsafe {
            crate::ffi::cwrs_mutable_network_profile_set_security(
                self.as_raw(),
                security.as_raw(),
            );
        }
    }
}

impl Default for MutableNetworkProfile {
    fn default() -> Self {
        Self::new().expect("CWMutableNetworkProfile init returned nil")
    }
}

impl Deref for MutableNetworkProfile {
    type Target = NetworkProfile;

    fn deref(&self) -> &Self::Target {
        &self.base
    }
}

impl From<MutableNetworkProfile> for NetworkProfile {
    fn from(value: MutableNetworkProfile) -> Self {
        value.base
    }
}

impl PartialEq for MutableNetworkProfile {
    fn eq(&self, other: &Self) -> bool {
        self.base == other.base
    }
}

impl Eq for MutableNetworkProfile {}