Update readme and don't expose Error directly

Author: ohadravid

README.md

@@ -8,17 +8,24 @@ Cross-platform library to retrieve network sockets information.
 Aims to be optimal by using low-level OS APIs instead of command line utilities.
 Provides unified interface and returns data structures which may have additional fields depending on platform.
 
+```toml
+# Cargo.toml
+[dependencies]
+netstat2 = "0.8"
+```
+
 This is a fork based on the [netstat](https://crates.io/crates/netstat) crate by [ivxvm](https://github.com/ivxvm).
 
 ## Example
 
 ```rust
-use netstat2::*;
+use netstat2::{get_sockets_info, AddressFamilyFlags, ProtocolFlags, ProtocolSocketInfo};
 
-fn main() {
+fn main() -> Result<(), Box<dyn std::error::Error>> {
     let af_flags = AddressFamilyFlags::IPV4 | AddressFamilyFlags::IPV6;
     let proto_flags = ProtocolFlags::TCP | ProtocolFlags::UDP;
-    let sockets_info = get_sockets_info(af_flags, proto_flags).unwrap();
+    let sockets_info = get_sockets_info(af_flags, proto_flags)?;
+    
     for si in sockets_info {
         match si.protocol_socket_info {
             ProtocolSocketInfo::Tcp(tcp_si) => println!(
@@ -36,6 +43,8 @@ fn main() {
             ),
         }
     }
+
+    Ok(())
 }
 ```
 

src/integrations/linux/api.rs

@@ -1,5 +1,6 @@
 use crate::integrations::linux::netlink_iterator::*;
 use crate::integrations::linux::procfs::*;
+use crate::types::error::Error;
 use crate::types::*;
 use libc::*;
 

src/integrations/linux/ext/tcp_state_ext.rs

@@ -14,7 +14,7 @@ impl From<u8> for TcpState {
             9 => TcpState::LastAck,
             10 => TcpState::Listen,
             11 => TcpState::Closing,
-            _ => panic!("Unknown TcpState!"),
+            _ => TcpState::Unknown,
         }
     }
 }

src/integrations/linux/netlink_iterator.rs

@@ -1,5 +1,6 @@
 use crate::integrations::linux::ffi::*;
 use crate::types::*;
+use crate::types::error::*;
 use libc::*;
 use std;
 use std::io;

src/integrations/osx/api.rs

@@ -1,4 +1,5 @@
 use crate::integrations::osx::netstat::*;
+use crate::types::error::Error;
 use crate::types::*;
 
 /// Iterate through sockets information.

src/integrations/osx/netstat.rs

@@ -12,12 +12,9 @@ use std::ptr;
 use std::{io, mem};
 
 use crate::integrations::osx::ffi::libproc::*;
+use crate::types::error::Error;
 use crate::types::{AddressFamilyFlags, ProtocolFlags};
-use crate::{Error, UdpSocketInfo};
-use crate::{ProtocolSocketInfo, SocketInfo, TcpSocketInfo, TcpState};
-use bitflags::_core::result::Result::Err;
-use std::collections::hash_map::Entry;
-use std::collections::HashMap;
+use crate::{ProtocolSocketInfo, SocketInfo, TcpSocketInfo, TcpState, UdpSocketInfo};
 
 pub type PID = c_int;
 

src/integrations/shared_api.rs

@@ -1,4 +1,5 @@
 use crate::integrations::*;
+use crate::types::error::Error;
 use crate::types::*;
 
 /// Retrieve sockets information as a vector.

src/integrations/windows/api.rs

@@ -1,6 +1,7 @@
 use crate::integrations::windows::ffi::*;
 use crate::integrations::windows::socket_table_iterator::SocketTableIterator;
 use crate::types::*;
+use crate::types::error::*;
 
 /// Iterate through sockets information.
 pub fn iterate_sockets_info(

src/integrations/windows/ext/tcp_state_ext.rs

@@ -16,7 +16,7 @@ impl From<ffi::DWORD> for TcpState {
             ffi::MIB_TCP_STATE_LAST_ACK => TcpState::LastAck,
             ffi::MIB_TCP_STATE_TIME_WAIT => TcpState::TimeWait,
             ffi::MIB_TCP_STATE_DELETE_TCB => TcpState::DeleteTcb,
-            _ => panic!("Unknown TcpState!"),
+            _ => TcpState::Unknown,
         }
     }
 }

src/integrations/windows/socket_table.rs

@@ -1,6 +1,7 @@
 use crate::integrations::windows::ffi::*;
 use crate::integrations::windows::socket_table_extended::SocketTable;
 use crate::types::*;
+use crate::types::error::*;
 use std;
 use std::net::{IpAddr, Ipv4Addr};