X-Git-Url: https://code.octet-stream.net/netwatcher/blobdiff_plain/244781f32194c2498ef0e3b8225a9ff9791624af..d2c9a9f306a336aa9dd8ddfb6579746e4f10b7a4:/src/lib.rs?ds=inline diff --git a/src/lib.rs b/src/lib.rs index 7a8298e..5c8d73d 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -43,7 +43,7 @@ impl Interface { } /// Information delivered via callback when a network interface change is detected. -/// +/// /// This contains up-to-date information about all interfaces, plus a diff which /// details which interfaces and IP addresses have changed since the last callback. #[derive(Debug, Clone, PartialEq, Eq)] @@ -122,29 +122,31 @@ impl List { } /// A handle to keep alive as long as you wish to receive callbacks. -/// +/// /// If the callback is executing at the time the handle is dropped, drop will block until /// the callback is finished and it's guaranteed that it will not be called again. -/// +/// /// Do not drop the handle from within the callback itself. It will probably deadlock. pub struct WatchHandle { _inner: watch::WatchHandle, } /// Retrieve information about all enabled network interfaces and their IP addresses. -/// +/// /// This is a once-off operation. If you want to detect changes over time, see `watch_interfaces`. pub fn list_interfaces() -> Result, Error> { list::list_interfaces().map(|list| list.0) } /// Retrieve interface information and watch for changes, which will be delivered via callback. -/// +/// /// If setting up the watch is successful, this returns a `WatchHandle` which must be kept for /// as long as the provided callback should operate. -/// +/// /// The callback will fire once immediately with an initial interface list, and a diff as if /// there were originally no interfaces present. -pub fn watch_interfaces(callback: F) -> Result { +pub fn watch_interfaces( + callback: F, +) -> Result { watch::watch_interfaces(callback).map(|handle| WatchHandle { _inner: handle }) }