Documented swimos_time.

Author: horned-sphere

swimos_utilities/swimos_multi_reader/src/lib.rs

@@ -13,10 +13,10 @@
 // limitations under the License.
 
 //! # Stream Aggregator
-//! 
+//!
 //! Provides an aggregator that combines a collection of [futures::Stream]s of the same type
 //! into a single [futures::Stream].
-//! 
+//!
 //! Additional streams can be added after initial construction.
 
 mod reader;

swimos_utilities/swimos_route/src/lib.rs

@@ -13,15 +13,15 @@
 // 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 patterns](`RoutePattern`) that can be used to extract components from the path of a
 //! route URI.
 
 mod route_pattern;

swimos_utilities/swimos_sync/src/lib.rs

@@ -13,7 +13,7 @@
 // limitations under the License.
 
 //! # Synchronization Channels
-//! 
+//!
 //! This crate contains asynchronous channels to communicate between tasks or threads.
 
 mod circular_buffer;

swimos_utilities/swimos_time/src/lib.rs

@@ -12,6 +12,10 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+//! # Time Utility
+//!
+//! Utility types and functions for working with timestamps and durations.
+
 mod instant;
 
 pub use instant::AtomicInstant;