gempress: document fields

lib/gempress/src/gemini.rs

@@ -3,12 +3,15 @@ use native_tls::TlsStream;
 use std::{io::Write, net::TcpStream, str::FromStr};
 use url::Url;
 
+/// A gemini request
 #[derive(Debug, PartialEq, Eq)]
 pub struct Request {
+    /// The requested resource path
     pub url: Url,
 }
 
 impl Request {
+    /// Parse a request object from text
     pub fn parse(request: &str) -> GempressResult<Self> {
         Self::from_str(request)
     }
@@ -60,11 +63,12 @@ impl FromStr for Request {
     }
 }
 
+/// A gemini response
 pub struct Response {
-    stream: TlsStream<TcpStream>,
     pub status: [u8; 2],
     pub meta: Vec<u8>,
     pub body: Vec<u8>,
+    stream: TlsStream<TcpStream>,
 }
 
 impl Response {
@@ -77,6 +81,7 @@ impl Response {
         }
     }
 
+    /// "Finish" the response and write it to the steeam
     pub fn send(&mut self, text: &[u8]) -> GempressResult<usize> {
         let mut buf: Vec<u8> = Vec::new();
 

lib/gempress/src/lib.rs

@@ -1,7 +1,9 @@
 extern crate native_tls;
 
-mod error;
+/// Types representing the gemini specification
 pub mod gemini;
+
+mod error;
 mod io;
 mod logger;
 

lib/gempress/src/logger.rs

@@ -1,9 +1,9 @@
 use std::fmt::Display;
 
-pub fn info(message: impl Display) {
+pub(crate) fn info(message: impl Display) {
     println!("[info] {}", message);
 }
 
-pub fn error(message: impl Display) {
+pub(crate) fn error(message: impl Display) {
     println!("[err] {}", message);
 }