Documented swimos_route.

Author: horned-sphere

swimos_utilities/swimos_route/src/lib.rs

@@ -12,6 +12,18 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+//! # SwimOS routes
+//! 
+//! A route is a URI with no authority that specified the location of a single SwimOS agent instance.
+//! It does not specify the host on which the agent can be found and this information must be retrieved
+//! from a routing table or provided separately.
+//! 
+//! This crate contains:
+//! 
+//! - A type to represent a [route URI](`RouteUri``).
+//! - [Route patterns](`RoutePattern`) that can be used to extract components from the path of a 
+//! route URI.
+
 mod route_pattern;
 mod route_uri;
 

swimos_utilities/swimos_route/src/route_uri/mod.rs

@@ -104,6 +104,7 @@ impl RouteUri {
     }
 }
 
+/// Error type that is produced by an attempt to parse an invalid [`RouteUri`] from a string.
 #[derive(Debug, Clone, PartialEq, Eq)]
 pub struct InvalidRouteUri(String);