From 14d34e76f4007e50af89bd47f6ad36f45494c50a Mon Sep 17 00:00:00 2001 From: Alex Auvolat Date: Wed, 2 Dec 2020 20:12:24 +0100 Subject: Documentate --- src/lib.rs | 26 +++++++++++++++++++++++--- 1 file changed, 23 insertions(+), 3 deletions(-) (limited to 'src/lib.rs') diff --git a/src/lib.rs b/src/lib.rs index 2db8a22..ba365c7 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,9 +1,29 @@ +//! Netapp is a Rust library that takes care of a few common tasks in distributed software: +//! +//! - establishing secure connections +//! - managing connection lifetime, reconnecting on failure +//! - checking peer's state +//! - peer discovery +//! - query/response message passing model for communications +//! - multiplexing transfers over a connection +//! - overlay networks: full mesh or random peer sampling using Basalt +//! +//! Of particular interest, read the documentation for the `netapp::NetApp` type, +//! the `message::Message` trait, and `proto::RequestPriority` to learn more +//! about message priorization. +//! Also check out the examples to learn how to use this crate. + #![feature(map_first_last)] -pub mod conn; pub mod error; +pub mod util; + +pub mod proto; pub mod message; + +mod conn; + pub mod netapp; pub mod peering; -pub mod proto; -pub mod util; + +pub use netapp::*; -- cgit v1.2.3