diff --git a/src/certificate.rs b/src/certificate.rs index bfa3a1d..14a16ef 100644 --- a/src/certificate.rs +++ b/src/certificate.rs @@ -1,3 +1,4 @@ +//! Dory's internal representation of a TLS certificate use crate::mailuser::Mailuser; use std::collections::{BTreeMap, HashMap}; diff --git a/src/connection/builder.rs b/src/connection/builder.rs index 0ece67a..edffae0 100644 --- a/src/connection/builder.rs +++ b/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}; diff --git a/src/connection/mod.rs b/src/connection/mod.rs index 453f05e..69f2106 100644 --- a/src/connection/mod.rs +++ b/src/connection/mod.rs @@ -1,3 +1,4 @@ +//! A connection for a recieving Misfin server pub mod builder; pub mod error; pub mod verifier; diff --git a/src/fingerprint/mod.rs b/src/fingerprint/mod.rs index 0b48e8c..c14edd4 100644 --- a/src/fingerprint/mod.rs +++ b/src/fingerprint/mod.rs @@ -1,3 +1,4 @@ +//! Fingerprinting for TLS certificates use { digest::Digest, rustls::Certificate, diff --git a/src/gemtext/mod.rs b/src/gemtext/mod.rs index 4bcc143..40b7779 100644 --- a/src/gemtext/mod.rs +++ b/src/gemtext/mod.rs @@ -1,2 +1,3 @@ +//! A Gemtext representation and parser pub mod parser; pub use parser::{GemtextNode, Parser}; diff --git a/src/host/mod.rs b/src/host/mod.rs index a7c1340..2fcdf24 100644 --- a/src/host/mod.rs +++ b/src/host/mod.rs @@ -1,3 +1,4 @@ +//! A DNS name for an internet host use std::{ fmt, net::{SocketAddr, ToSocketAddrs}, diff --git a/src/mailbox/mod.rs b/src/mailbox/mod.rs index 011845e..d30ffbe 100644 --- a/src/mailbox/mod.rs +++ b/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}; diff --git a/src/mailstore/mod.rs b/src/mailstore/mod.rs index f654005..e146168 100644 --- a/src/mailstore/mod.rs +++ b/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}; diff --git a/src/mailuser/mod.rs b/src/mailuser/mod.rs index 02d2bdd..7ea6fa3 100644 --- a/src/mailuser/mod.rs +++ b/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}; diff --git a/src/message/mod.rs b/src/message/mod.rs index a9b3a41..4cb74eb 100644 --- a/src/message/mod.rs +++ b/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}; diff --git a/src/receiver/mod.rs b/src/receiver/mod.rs index 8b13789..8ef8b7a 100644 --- a/src/receiver/mod.rs +++ b/src/receiver/mod.rs @@ -1 +1 @@ - +//! Accepts a connection and processes an incoming request diff --git a/src/request/mod.rs b/src/request/mod.rs index 5881ee0..95d53ad 100644 --- a/src/request/mod.rs +++ b/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}; diff --git a/src/response/mod.rs b/src/response/mod.rs index 46f4939..b055cbf 100644 --- a/src/response/mod.rs +++ b/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}; diff --git a/src/sender/mod.rs b/src/sender/mod.rs index b9daef1..ebcad19 100644 --- a/src/sender/mod.rs +++ b/src/sender/mod.rs @@ -1,3 +1,4 @@ +//! Sends a Misfin [`Request`] use { crate::prelude::{CertificateStore, ClientCertificateStore, Mailuser, Request, Response}, rustls::{ClientConfig, ClientConnection, StreamOwned}, diff --git a/src/status/mod.rs b/src/status/mod.rs index ffe642a..0e387d4 100644 --- a/src/status/mod.rs +++ b/src/status/mod.rs @@ -1,3 +1,4 @@ +//! Return status codes for Misfin mod error; pub use error::Error;