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

#![cfg_attr(docsrs, feature(doc_cfg))]
#![allow(
    clippy::borrow_as_ptr,
    clippy::doc_markdown,
    clippy::missing_const_for_fn,
    clippy::missing_errors_doc,
    clippy::missing_panics_doc,
    clippy::module_name_repetitions,
    clippy::must_use_candidate,
    clippy::redundant_pub_crate,
    clippy::similar_names,
    clippy::use_self
)]
#![doc = include_str!("../README.md")]

#[cfg(not(target_os = "macos"))]
compile_error!("systemconfiguration only supports macOS");

mod bond_interface;
mod bridge;
mod captive_network;
mod console_user;
mod dynamic_store;
mod error;
mod ffi;
mod network_configuration;
mod network_connection;
mod network_interface;
mod network_protocol;
mod network_reachability;
mod network_services;
mod network_sets;
mod preferences;
mod property_list;
mod schema;
/// Wraps constants from `SCSchemaDefinitions.h`.
pub mod schema_definitions;
mod system_configuration;
mod vlan_interface;

/// Re-exports the corresponding SystemConfiguration wrappers.
pub use bond_interface::{BondInterface, BondStatus};
/// Re-exports the corresponding SystemConfiguration wrappers.
pub use captive_network::CaptiveNetwork;
/// Re-exports the corresponding SystemConfiguration wrappers.
pub use console_user::ConsoleUser;
/// Re-exports the corresponding SystemConfiguration wrappers.
pub use dynamic_store::{DynamicStore, DynamicStoreRunLoopSource};
/// Re-exports the corresponding SystemConfiguration wrappers.
pub use error::{Result, SystemConfigurationError};
/// Re-exports the corresponding SystemConfiguration wrappers.
pub use network_configuration::{NetworkConfiguration, NetworkConfigurationOverview};
/// Re-exports the corresponding SystemConfiguration wrappers.
pub use network_connection::{
    NetworkConnection, NetworkConnectionFlags, NetworkConnectionPppStatus, NetworkConnectionStatus,
    NetworkConnectionUserPreferences,
};
/// Re-exports the corresponding SystemConfiguration wrappers.
pub use network_interface::{
    NetworkInterface, NetworkInterfaceMediaOptions, NetworkInterfaceMtuInfo,
};
/// Re-exports the corresponding SystemConfiguration wrappers.
pub use network_protocol::NetworkProtocol;
/// Re-exports the corresponding SystemConfiguration wrappers.
pub use network_reachability::{NetworkReachability, Reachability, ReachabilityFlags};
/// Re-exports the corresponding SystemConfiguration wrappers.
pub use network_services::NetworkService;
/// Re-exports the corresponding SystemConfiguration wrappers.
pub use network_sets::NetworkSet;
/// Re-exports the corresponding SystemConfiguration wrappers.
pub use preferences::{Preferences, PreferencesNotification};
/// Re-exports the corresponding SystemConfiguration wrappers.
pub use property_list::PropertyList;
/// Re-exports the corresponding SystemConfiguration wrappers.
pub use schema::{Schema, SchemaCatalog};
/// Re-exports the corresponding SystemConfiguration wrappers.
pub use system_configuration::{SystemConfiguration, SystemConfigurationLastError};
/// Re-exports the corresponding SystemConfiguration wrappers.
pub use vlan_interface::VlanInterface;

#[cfg(feature = "raw-ffi")]
/// Wraps raw SystemConfiguration FFI exports.
pub mod raw_ffi;

#[cfg(feature = "async")]
#[cfg_attr(docsrs, doc(cfg(feature = "async")))]
/// Wraps async SystemConfiguration callback streams.
pub mod async_api;

/// Re-exports common SystemConfiguration wrapper types.
pub mod prelude {
    /// Re-exports the corresponding SystemConfiguration wrappers.
    pub use crate::{
        schema_definitions, BondInterface, BondStatus, CaptiveNetwork, ConsoleUser, DynamicStore,
        DynamicStoreRunLoopSource, NetworkConfiguration, NetworkConfigurationOverview,
        NetworkConnection, NetworkConnectionFlags, NetworkConnectionPppStatus,
        NetworkConnectionStatus, NetworkConnectionUserPreferences, NetworkInterface,
        NetworkInterfaceMediaOptions, NetworkInterfaceMtuInfo, NetworkProtocol,
        NetworkReachability, NetworkService, NetworkSet, Preferences, PreferencesNotification,
        PropertyList, Reachability, ReachabilityFlags, Result, Schema, SchemaCatalog,
        SystemConfiguration, SystemConfigurationError, SystemConfigurationLastError, VlanInterface,
    };
}