Spell check with typos. Add spell-check CI job

.github/workflows/ci.yml

@@ -13,6 +13,12 @@ env:
   VERBOSE: 1
 
 jobs:
+  spell-check:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: crate-ci/typos@master
+
   build-ubuntu:
     runs-on: ubuntu-latest
     steps:

pnet_base/src/macaddr.rs

@@ -310,7 +310,7 @@ mod tests {
     }
 
     #[test]
-    fn convertion() {
+    fn conversion() {
         let mac = MacAddr(0x12, 0x34, 0x56, 0x78, 0x90, 0xAB);
         let addr = [0x12, 0x34, 0x56, 0x78, 0x90, 0xAB];
 

pnet_datalink/src/bpf.rs

@@ -294,7 +294,7 @@ impl DataLinkSender for DataLinkSenderImpl {
                     )
                 };
                 if ret == -1 {
-                    // Error occured!
+                    // Error occurred!
                     return Some(Err(io::Error::last_os_error()));
                 } else if ret == 0 {
                     return Some(Err(io::Error::new(io::ErrorKind::TimedOut, "Timed out")));
@@ -339,7 +339,7 @@ impl DataLinkSender for DataLinkSenderImpl {
             )
         };
         if ret == -1 {
-            // Error occured!
+            // Error occurred!
             return Some(Err(io::Error::last_os_error()));
         } else if ret == 0 {
             return Some(Err(io::Error::new(io::ErrorKind::TimedOut, "Timed out")));

pnet_datalink/src/winpcap.rs

@@ -343,7 +343,7 @@ pub fn interfaces() -> Vec<NetworkInterface> {
         buf.resize(buflen as usize, 0);
 
         // Second call should now work with the correct buffer size. If not, this may be
-        // due to some privilege or other unforseen issue.
+        // due to some privilege or other unforeseen issue.
         if unsafe { winpcap::PacketGetAdapterNames(buf.as_mut_ptr() as *mut i8, &mut buflen) } == 0
         {
             panic!("Unable to get interface list despite increasing buffer size");

pnet_sys/src/lib.rs

@@ -111,7 +111,7 @@ pub fn set_socket_receive_timeout(socket: CSocket, t: Duration) -> io::Result<()
     }
 }
 
-/// Extracts and returns a timout for reading from the socket.
+/// Extracts and returns a timeout for reading from the socket.
 #[cfg(unix)]
 pub fn get_socket_receive_timeout(socket: CSocket) -> io::Result<Duration> {
     let ts = libc::timeval {

src/lib.rs

@@ -31,7 +31,7 @@
 //!
 //! ## Terminology
 //!
-//! The documentation uses the following terms interchangably:
+//! The documentation uses the following terms interchangeably:
 //!
 //!  * Layer 2, datalink layer;
 //!  * Layer 3, network layer;
@@ -48,7 +48,7 @@
 //! ### Ethernet echo server
 //!
 //! This (fairly useless) code implements an Ethernet echo server. Whenever a
-//! packet is received on an interface, it echo's the packet back; reversing the
+//! packet is received on an interface, it echoes the packet back; reversing the
 //! source and destination addresses.
 //!
 //! ```rust,ignore

typos.toml

@@ -0,0 +1,6 @@
+[default]
+extend-ignore-identifiers-re = [
+    "tolen",
+    "ND",
+    "SunNd",
+]