docs: expand documentation to most types

Author: paolobarbolini

src/ip_version.rs

@@ -1,13 +1,10 @@
 use std::{
-    fmt::Display,
     hash::Hash,
     net::{Ipv4Addr, Ipv6Addr},
 };
 
-pub trait IpVersion:
-    Copy + Sized + Hash + Eq + Unpin + Send + Sync + Display + 'static + private::Sealed
-{
-}
+/// Either an [`Ipv4Addr`] or an [`Ipv6Addr`].
+pub trait IpVersion: Copy + Hash + Eq + Unpin + Send + Sync + 'static + private::Sealed {}
 
 impl IpVersion for Ipv4Addr {}
 impl IpVersion for Ipv6Addr {}

src/packet.rs

@@ -1,3 +1,7 @@
+//! ICMP packets implementation used by [`raw_pinger`].
+//!
+//! [`raw_pinger`]: crate::raw_pinger
+
 use std::{borrow::Cow, marker::PhantomData};
 
 use pnet_packet::{

src/raw_pinger/blocking.rs

@@ -13,6 +13,7 @@ use crate::{
     IpVersion,
 };
 
+/// Synchronous pinger
 pub struct RawBlockingPinger<V: IpVersion> {
     socket: BaseSocket,
     _version: PhantomData<V>,
@@ -28,11 +29,13 @@ impl<V: IpVersion> RawBlockingPinger<V> {
         })
     }
 
+    /// Send a ICMP ECHO request packet
     pub fn send_to(&self, addr: V, packet: &EchoRequestPacket<V>) -> io::Result<()> {
         let addr = addr.to_socket_addr();
         self.socket.send_to(packet.as_bytes(), addr).map(|_sent| ())
     }
 
+    /// Receive an ICMP ECHO reply packet
     pub fn recv(&self, buf: &mut [MaybeUninit<u8>]) -> io::Result<Option<EchoReplyPacket<'_, V>>> {
         let (received, source) = match self.socket.recv(buf) {
             Ok((received, source)) => (received, source),

src/raw_pinger/mod.rs

@@ -1,3 +1,5 @@
+//! Synchronous and asynchronous raw pinger implementation
+
 use std::{
     borrow::Cow,
     future::Future,
@@ -23,6 +25,7 @@ pub type RawV6Pinger = RawPinger<Ipv6Addr>;
 
 mod blocking;
 
+/// Asynchronous pinger
 pub struct RawPinger<V: IpVersion> {
     socket: Socket,
     _version: PhantomData<V>,
@@ -38,6 +41,7 @@ impl<V: IpVersion> RawPinger<V> {
         })
     }
 
+    /// Send a ICMP ECHO request packet
     pub fn send_to<'a>(&'a self, addr: V, packet: &'a EchoRequestPacket<V>) -> SendFuture<'a, V> {
         SendFuture {
             pinger: self,
@@ -46,6 +50,7 @@ impl<V: IpVersion> RawPinger<V> {
         }
     }
 
+    /// Send a ICMP ECHO request packet
     pub fn poll_send_to(
         &self,
         cx: &mut Context<'_>,
@@ -58,13 +63,15 @@ impl<V: IpVersion> RawPinger<V> {
         Poll::Ready(result.map(|_sent| ()))
     }
 
+    /// Receive an ICMP ECHO reply packet
     pub fn recv(&self) -> RecvFuture<'_, V> {
         RecvFuture {
             pinger: self,
             buf: Vec::with_capacity(1600),
         }
     }
 
+    /// Receive an ICMP ECHO reply packet
     pub fn poll_recv(
         &self,
         cx: &mut Context<'_>,
@@ -87,6 +94,7 @@ impl<V: IpVersion> RawPinger<V> {
     }
 }
 
+/// [`Future`] obtained from [`RawPinger::send_to`].
 pub struct SendFuture<'a, V: IpVersion> {
     pinger: &'a RawPinger<V>,
     addr: V,
@@ -101,6 +109,7 @@ impl<'a, V: IpVersion> Future for SendFuture<'a, V> {
     }
 }
 
+/// [`Future`] obtained from [`RawPinger::recv`].
 pub struct RecvFuture<'a, V: IpVersion> {
     pinger: &'a RawPinger<V>,
     buf: Vec<u8>,