Make example program test dropping the WatchHandle

[netwatcher] / src / lib.rs

diff --git a/src/lib.rs b/src/lib.rs
index 5c8d73d3a9dc79871ea3a25565cdc7a0ddc8c029..495b9e64f5098aadb9b1d7d8b8d7f4a4603f2a40 100644 (file)
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -4,17 +4,24 @@ use std::{
     ops::Sub,
 };
 
+mod error;
+
 #[cfg_attr(windows, path = "list_win.rs")]
 #[cfg_attr(unix, path = "list_unix.rs")]
 mod list;
 
 #[cfg_attr(windows, path = "watch_win.rs")]
 #[cfg_attr(target_vendor = "apple", path = "watch_mac.rs")]
-#[cfg_attr(target_os = "linux", path = "watch_linux.rs")]
+#[cfg_attr(
+    any(target_os = "linux", target_os = "android"),
+    path = "watch_linux.rs"
+)]
 mod watch;
 
 type IfIndex = u32;
 
+pub use error::Error;
+
 /// Information about one network interface at a point in time.
 #[derive(Debug, Clone, PartialEq, Eq)]
 pub struct Interface {
@@ -68,13 +75,6 @@ pub struct InterfaceDiff {
     pub addrs_removed: Vec<IpAddr>,
 }
 
-/// Errors in netwatcher or in one of the underlying platform integratinos.
-#[derive(Debug, Clone, PartialEq, Eq)]
-pub enum Error {
-    // TODO: handle all cases with proper sources
-    Internal,
-}
-
 #[derive(Default, PartialEq, Eq)]
 struct List(HashMap<IfIndex, Interface>);
 
@@ -145,6 +145,13 @@ pub fn list_interfaces() -> Result<HashMap<IfIndex, Interface>, Error> {
 ///
 /// The callback will fire once immediately with an initial interface list, and a diff as if
 /// there were originally no interfaces present.
+///
+/// This function will return an error if there is a problem configuring the watcher, or if there
+/// is an error retrieving the initial interface list.
+///
+/// We assume that if listing the interfaces worked the first time, then it will continue to work
+/// for as long as the watcher is running. If listing interfaces begins to fail later, those
+/// failures will be swallowed and the callback will not be called for that change event.
 pub fn watch_interfaces<F: FnMut(Update) + Send + 'static>(
     callback: F,
 ) -> Result<WatchHandle, Error> {