Added a lot of doc strings identifying various modules

src/certificate.rs

@@ -1,3 +1,4 @@
+//! Dory's internal representation of a TLS certificate
 use crate::mailuser::Mailuser;
 use std::collections::{BTreeMap, HashMap};
 

src/connection/builder.rs

@@ -1,3 +1,4 @@
+//! Builds an incoming connection from a TCP stream and certificate verifier
 use super::{FingerPrintStore, Verifier};
 use rustls::ServerConfig;
 use std::{net::TcpStream, sync::Arc};

src/connection/mod.rs

@@ -1,3 +1,4 @@
+//! A connection for a recieving Misfin server
 pub mod builder;
 pub mod error;
 pub mod verifier;

src/fingerprint/mod.rs

@@ -1,3 +1,4 @@
+//! Fingerprinting for TLS certificates
 use {
     digest::Digest,
     rustls::Certificate,

src/gemtext/mod.rs

@@ -1,2 +1,3 @@
+//! A Gemtext representation and parser
 pub mod parser;
 pub use parser::{GemtextNode, Parser};

src/host/mod.rs

@@ -1,3 +1,4 @@
+//! A DNS name for an internet host
 use std::{
     fmt,
     net::{SocketAddr, ToSocketAddrs},

src/mailbox/mod.rs

@@ -1,3 +1,4 @@
+//! A full representation of a Misfin mailbox, including display name
 use crate::{mailuser::Mailuser, prelude::Host};
 use std::{fmt, str::FromStr};
 

src/mailstore/mod.rs

@@ -1,3 +1,4 @@
+//! A trait for abstracting mail storage
 #![allow(unused_variables)]
 use crate::prelude::{Host, Mailbox, Mailuser, Message};
 use std::{collections::HashMap, io, str::FromStr};

src/mailuser/mod.rs

@@ -1,3 +1,4 @@
+//! A naive representation of a Misfin address, minus display name
 use crate::prelude::{Host, Mailbox, ParseMailboxError as Error};
 use std::{fmt, str::FromStr};
 

src/message/mod.rs

@@ -1,3 +1,4 @@
+//! A Misfin message broken out into component parts, useful for client display
 use crate::prelude::Mailbox;
 use std::{fmt, str::FromStr};
 

src/receiver/mod.rs

@@ -1 +1 @@
-
+//! Accepts a connection and processes an incoming request

src/request/mod.rs

@@ -1,3 +1,4 @@
+//! A Misfin request, made up of a recipient address and a message string
 use crate::prelude::{Mailbox, Mailuser};
 use std::{fmt, str::FromStr};
 

src/response/mod.rs

@@ -1,3 +1,4 @@
+//! Parses the receiving server's response to the sender
 use crate::prelude::Status;
 use std::{fmt, str::FromStr};
 

src/sender/mod.rs

@@ -1,3 +1,4 @@
+//! Sends a Misfin [`Request`]
 use {
     crate::prelude::{CertificateStore, ClientCertificateStore, Mailuser, Request, Response},
     rustls::{ClientConfig, ClientConnection, StreamOwned},

src/status/mod.rs

@@ -1,3 +1,4 @@
+//! Return status codes for Misfin
 mod error;
 pub use error::Error;