peach-workspace/peach-network/src/lib.rs

#![warn(missing_docs)]

//! # peach-network
//!
//! Network interface state query and modification library; designed for use
//! with the PeachCloud platform.
//!
//! The `src/network.rs` module contains the core networking logic and data
//! types for interacting with the `wpa_supplicant` process and related parts of
//! the operating system, while the `src/error.rs` module contains
//! error-handling data types and methods.
//!
//! ## Example Usage
//!
//! ```rust
//! use peach_network::{network, NetworkError};
//!
//! fn main() -> Result<(), NetworkError> {
//!     let wlan_iface = "wlan0";
//!
//!     let wlan_ip = network::ip(wlan_iface);
//!     let wlan_ssid = network::ssid(wlan_iface);
//!
//!     let ssid = "Home";
//!     let pass = "SuperSecret";
//!     
//!     //network::add(&wlan_iface, &ssid, &pass)?;
//!     //network::save()?;
//!     
//!     Ok(())
//! }
//! ```
//!
//! ## Feature Flags
//!
//! Feature flags are used to offer `Serialize` and `Deserialize` implementations
//! for all `struct` data types provided by this library. These traits are not
//! provided by default. A choice of `miniserde` and `serde` is provided.
//!
//! Define the desired feature in the `Cargo.toml` manifest of your project:
//!
//! ```toml
//! peach-network = { version = "0.3.0", features = ["miniserde_support"] }
//! ```

pub mod error;
pub mod network;
mod utils;

pub use crate::error::NetworkError;