Add top-level docs and update README

[netwatcher] / src / list_unix.rs

diff --git a/src/list_unix.rs b/src/list_unix.rs
index a6b2bd3bec616d4237f86801e92b96c13cbcee47..4a491402282893e1b7043cd05ffa1a0e640f7d05 100644 (file)
--- a/src/list_unix.rs
+++ b/src/list_unix.rs
@@ -1,11 +1,9 @@
 use std::fmt::Write;
 use std::{collections::HashMap, net::IpAddr};
 
-use block2::Block;
-use nix::libc::c_long;
 use nix::{ifaddrs::getifaddrs, net::if_::if_nametoindex};
 
-use crate::{Error, IfIndex, Interface};
+use crate::{Error, Interface, List};
 
 struct CandidateInterface {
     name: String,
@@ -14,12 +12,13 @@ struct CandidateInterface {
     ips: Vec<IpAddr>,
 }
 
-pub(crate) fn list_interfaces() -> Result<HashMap<IfIndex, Interface>, Error> {
-    let addrs = getifaddrs().map_err(|_| Error::Internal)?;
+pub(crate) fn list_interfaces() -> Result<List, Error> {
+    let addrs = getifaddrs().map_err(|e| Error::Getifaddrs(e.to_string()))?;
     let mut candidates = HashMap::new();
 
     for addr in addrs {
-        let index = if_nametoindex(addr.interface_name.as_str()).map_err(|_| Error::Internal)?;
+        let index = if_nametoindex(addr.interface_name.as_str())
+            .map_err(|e| Error::GetInterfaceName(e.to_string()))?;
         let candidate = candidates
             .entry(addr.interface_name.clone())
             .or_insert_with(|| CandidateInterface {
@@ -59,16 +58,16 @@ pub(crate) fn list_interfaces() -> Result<HashMap<IfIndex, Interface>, Error> {
             })
         })
         .collect();
-    Ok(ifs)
+    Ok(List(ifs))
 }
 
 fn format_mac(bytes: &[u8]) -> Result<String, Error> {
     let mut mac = String::with_capacity(bytes.len() * 3);
-    for i in 0..bytes.len() {
+    for (i, b) in bytes.iter().enumerate() {
         if i != 0 {
-            write!(mac, ":").map_err(|_| Error::Internal)?;
+            write!(mac, ":").map_err(|_| Error::FormatMacAddress)?;
         }
-        write!(mac, "{:02X}", bytes[i]).map_err(|_| Error::Internal)?;
+        write!(mac, "{:02X}", b).map_err(|_| Error::FormatMacAddress)?;
     }
     Ok(mac)
 }