Updated swimos_messages docs.

Author: horned-sphere

runtime/swimos_messages/src/lib.rs

@@ -16,8 +16,9 @@
 //!
 //! Encodes the protocol used to communicate between external sockets and agent runtime components.
 
-/// Message types and Tokio encoders and decoders.
+/// Message types between the runtime and agents with Tokio encoders and decoders.
 pub mod protocol;
+/// Message types between the runtime and tasks managing sockets.
 pub mod remote_protocol;
 /// Utilities to strip the header fields from Warp frames.
 pub mod warp;

runtime/swimos_messages/src/remote_protocol/mod.rs

@@ -21,6 +21,7 @@ use thiserror::Error;
 use tokio::sync::{mpsc, oneshot};
 use uuid::Uuid;
 
+/// Error type produced when a node cannot be resolved locally.
 #[derive(Debug, Error)]
 pub enum LinkError {
     #[error("No endpoint with address: {0}")]
@@ -62,17 +63,27 @@ pub struct FindNode {
     pub request: NodeConnectionRequest,
 }
 
+/// A request to connect to open a connection to an endpoint on a node.
 pub enum NodeConnectionRequest {
+    /// Request an uplink from a Warp lane.
     Warp {
+        /// The ID of the source of the request.
         source: Uuid,
+        /// Promise to satisfy with a bidirectional channel attached to the uplink.
         promise: oneshot::Sender<Result<(ByteWriter, ByteReader), AgentResolutionError>>,
     },
+    /// Open a channel to make HTTP requests to a lane.
     Http {
+        /// Promise to be satisfied with a channel to make HTTP requests to the lane.
         promise: oneshot::Sender<Result<mpsc::Sender<HttpLaneRequest>, AgentResolutionError>>,
     },
 }
 
 impl NodeConnectionRequest {
+    /// Fail a request for a channel.
+    ///
+    /// # Arguments
+    /// * `err` - The reason for the failure.
     pub fn fail(self, err: AgentResolutionError) -> Result<(), AgentResolutionError> {
         match self {
             NodeConnectionRequest::Warp { promise, .. } => match promise.send(Err(err)) {

runtime/swimos_remote/src/plain.rs

@@ -29,7 +29,7 @@ use tokio::net::{TcpListener, TcpStream};
 use crate::dns::BoxDnsResolver;
 use crate::net::{ClientConnections, ConnResult, ListenerResult, ServerConnections};
 
-/// Implementation of [`ServerConnections`] and [`ClientConnections`], using [`TcpListener`] 
+/// Implementation of [`ServerConnections`] and [`ClientConnections`], using [`TcpListener`]
 /// and [`TcpStream`] from Tokio.
 #[derive(Debug, Clone)]
 pub struct TokioPlainTextNetworking {