Add docs

Author: badeend

crates/test-programs/src/bin/p2_udp_connect.rs

@@ -76,7 +76,7 @@ fn test_udp_connect_wrong_family(net: &Network, family: IpAddressFamily) {
     ));
 }
 
-/// Connect without an explicit bind should fail.
+/// Socket must be explicitly bound before connecting.
 fn test_udp_connect_without_bind(family: IpAddressFamily) {
     let remote_addr = IpSocketAddress::new(IpAddress::new_loopback(family), SOME_PORT);
 

crates/wasi/src/sockets/tcp.rs

@@ -381,6 +381,7 @@ impl TcpSocket {
         }
     }
 
+    /// Start listening using p2 semantics. (no implicit bind)
     pub(crate) fn start_listen_p2(&mut self) -> Result<(), ErrorCode> {
         match mem::replace(&mut self.tcp_state, TcpState::Closed) {
             TcpState::Bound(tokio_socket) => {
@@ -406,6 +407,7 @@ impl TcpSocket {
         self.listen_common(tokio_socket)
     }
 
+    /// Start listening using p3 semantics. (with implicit bind)
     #[cfg(feature = "p3")]
     pub(crate) fn listen_p3(&mut self) -> Result<(), ErrorCode> {
         let tokio_socket = match mem::replace(&mut self.tcp_state, TcpState::Closed) {

crates/wasi/src/sockets/udp.rs

@@ -129,6 +129,7 @@ impl UdpSocket {
         Ok(())
     }
 
+    /// Connect using p2 semantics. (no implicit bind)
     pub(crate) fn connect_p2(&mut self, addr: SocketAddr) -> Result<(), ErrorCode> {
         match self.udp_state {
             UdpState::Bound | UdpState::Connected(_) => {}
@@ -138,6 +139,7 @@ impl UdpSocket {
         self.connect_common(addr)
     }
 
+    /// Connect using p3 semantics. (with implicit bind)
     #[cfg(feature = "p3")]
     pub(crate) fn connect_p3(&mut self, addr: SocketAddr) -> Result<(), ErrorCode> {
         match self.udp_state {
@@ -177,6 +179,7 @@ impl UdpSocket {
         Ok(())
     }
 
+    /// Send data using p3 semantics. (with implicit bind)
     #[cfg(feature = "p3")]
     pub(crate) fn send_p3(
         &mut self,
@@ -237,6 +240,7 @@ impl UdpSocket {
         }
     }
 
+    /// Receive data using p3 semantics.
     #[cfg(feature = "p3")]
     pub(crate) fn receive_p3(
         &self,