Chore(Docs): Add More Detailed Documentation

This commit is contained in:
Tochukwu Nkemdilim
2018-08-16 23:54:04 +01:00
parent be1064b383
commit 03325c939a
17 changed files with 294 additions and 60 deletions
+6 -3
View File
@@ -1,12 +1,14 @@
use connectivity::{Network, WifiConnectionError};
use connectivity::{Connectivity, WifiConnectionError};
use platforms::{Connection, WiFi, WifiError, WifiInterface};
use std::process::Command;
impl Network for WiFi {
/// Wireless network connectivity functionality.
impl Connectivity for WiFi {
/// Attempts to connect to a wireless network with a given SSID and password.
fn connect(&mut self, ssid: &str, password: &str) -> Result<bool, WifiConnectionError> {
if !WiFi::is_wifi_enabled().map_err(|err| WifiConnectionError::Other { kind: err })? {
return Err(WifiConnectionError::Other {
kind: WifiError::InterfaceDisabled,
kind: WifiError::WifiDisabled,
});
}
@@ -38,6 +40,7 @@ impl Network for WiFi {
Ok(true)
}
/// Attempts to disconnect from a wireless network currently connected to.
fn disconnect(&self) -> Result<bool, WifiConnectionError> {
let output = Command::new("nmcli")
.args(&["d", "disconnect", "ifname", &self.interface])