Documented the swimos_sync crate.

Author: horned-sphere

swimos_utilities/swimos_sync/src/circular_buffer/mod.rs

@@ -55,6 +55,7 @@ pub fn channel<T: Send>(capacity: NonZeroUsize) -> (Sender<T>, Receiver<T>) {
     (Sender(inner.clone()), Receiver(inner))
 }
 
+/// Create a circular buffer channel with a single entry.
 pub fn watch_channel<T: Send>() -> (Sender<T>, Receiver<T>) {
     channel(unsafe { NonZeroUsize::new_unchecked(1) })
 }
@@ -192,6 +193,7 @@ where
     }
 }
 
+/// The future type returned by the [`Receiver::recv`] method.
 #[derive(Debug)]
 pub struct Recv<'a, T>(&'a mut Receiver<T>);
 

swimos_utilities/swimos_sync/src/lib.rs

@@ -12,6 +12,10 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+//! # Synchronization Channels
+//! 
+//! This crate contains asynchronous channels to communicate between tasks or threads.
+
 mod circular_buffer;
 
 pub use circular_buffer::{channel, watch_channel, Receiver, Recv, Sender};