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

//! `CWConfiguration` wrapper.

use crate::{
    error::CoreWlanError,
    object::{collect_ordered_set, RetainedObject},
    network_profile::NetworkProfile,
};

#[derive(Debug, Clone)]
pub struct Configuration {
    obj: RetainedObject,
}

impl Configuration {
    /// # Errors
    ///
    /// Returns an error if the framework unexpectedly returns `nil`.
    pub fn new() -> crate::Result<Self> {
        unsafe {
            Self::from_owned_raw(crate::ffi::cwrs_configuration_new())
                .ok_or(CoreWlanError::UnexpectedNull("[[CWConfiguration alloc] init]"))
        }
    }

    /// # Errors
    ///
    /// Returns an error if copying the configuration unexpectedly yields `nil`.
    pub fn from_configuration(configuration: &Self) -> crate::Result<Self> {
        unsafe {
            Self::from_owned_raw(crate::ffi::cwrs_configuration_with_configuration(
                configuration.as_raw(),
            ))
            .ok_or(CoreWlanError::UnexpectedNull("[CWConfiguration copy]"))
        }
    }

    pub(crate) unsafe fn from_owned_raw(raw: crate::ffi::Object) -> Option<Self> {
        RetainedObject::from_owned_raw(raw).map(|obj| Self { obj })
    }

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

    #[must_use]
    pub fn network_profiles(&self) -> Vec<NetworkProfile> {
        unsafe {
            collect_ordered_set(crate::ffi::cwrs_configuration_network_profiles(self.as_raw()))
                .into_iter()
                .filter_map(|raw| NetworkProfile::from_owned_raw(raw))
                .collect()
        }
    }

    #[must_use]
    pub fn require_administrator_for_association(&self) -> bool {
        unsafe { crate::ffi::cwrs_configuration_require_admin_association(self.as_raw()) }
    }

    #[must_use]
    pub fn require_administrator_for_power(&self) -> bool {
        unsafe { crate::ffi::cwrs_configuration_require_admin_power(self.as_raw()) }
    }

    #[must_use]
    pub fn require_administrator_for_ibss_mode(&self) -> bool {
        unsafe { crate::ffi::cwrs_configuration_require_admin_ibss_mode(self.as_raw()) }
    }

    #[must_use]
    pub fn remember_joined_networks(&self) -> bool {
        unsafe { crate::ffi::cwrs_configuration_remember_joined_networks(self.as_raw()) }
    }
}

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

impl PartialEq for Configuration {
    fn eq(&self, other: &Self) -> bool {
        unsafe { crate::ffi::cwrs_configuration_equal(self.as_raw(), other.as_raw()) }
    }
}

impl Eq for Configuration {}