general comment improvements

Author: blobcode

src/args.rs

@@ -17,10 +17,10 @@ pub fn parse() -> Opts {
         .fallback("./cobalt.toml".to_string())
         .from_str();
 
-    // combine parsers `speed` and `distance` parsers into a parser for Opts
+    // combine all parsers
     let parser = construct!(Opts { path });
 
-    // define help message, attach it to parser, and run the results
+    // define help message,
     Info::default()
         .descr("cobalt - a simple reverse proxy by blobcode")
         .for_parser(parser)

src/config.rs

@@ -9,14 +9,14 @@ pub struct Config {
     pub hosts: HashMap<String, String>,
 }
 
-// toml representation
+// toml representation (main)
 #[derive(Deserialize)]
 pub struct ConfigToml {
     pub port: u16,
     pub host: Vec<HostToml>,
 }
 
-// toml representation
+// toml representation (for hosts)
 #[derive(Deserialize)]
 pub struct HostToml {
     pub from: Vec<String>,
@@ -38,9 +38,9 @@ fn parsehosts(config: ConfigToml) -> HashMap<String, String> {
     hosts
 }
 
-// main function to get config struct
+// get config struct
 pub fn parse(file: PathBuf) -> Result<Config, Box<dyn Error>> {
-    // load config
+    // load config from file
     let buf = fs::read_to_string(file)?;
 
     // parse file contents

src/main.rs

@@ -6,7 +6,7 @@ mod server;
 
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn Error>> {
-    // logging setup
+    // logging setup - log at info level
     simple_logger::init_with_level(log::Level::Info)?;
 
     // get args

src/server.rs

@@ -15,9 +15,9 @@ pub struct Server {
 impl Server {
     // start server
     pub async fn run(&self) -> Result<(), Box<dyn Error>> {
+        // setup address
         let listen_addr = "localhost:".to_string() + &self.port.to_string();
 
-        // start server
         log::info!("cobalt started");
         let listener = TcpListener::bind(&listen_addr).await?;
         log::info!("listening on: http://{}", listen_addr);
@@ -48,12 +48,11 @@ async fn handle(inbound: TcpStream, hosts: HashMap<String, String>) -> Result<()
     inbound.peek(&mut buf).await?;
     r.parse(&buf)?;
 
-    // parse headers
+    // try to parse headers
     let p = headers.iter().position(|&h| h.name == "Host").unwrap();
     let host = String::from_utf8_lossy(headers[p].value).to_string();
     let to = &hosts[&host];
 
-    // proxy
     let proxy = proxy(inbound, to.to_string()).map(|r| {
         if let Err(e) = r {
             log::error!("failed to proxy; {}", e);
@@ -66,12 +65,12 @@ async fn handle(inbound: TcpStream, hosts: HashMap<String, String>) -> Result<()
     Ok(())
 }
 
-// proxy tcpstream
+// proxy tcpstreams
 async fn proxy(mut inbound: TcpStream, proxy_addr: String) -> Result<(), Box<dyn Error>> {
-    // connect to server
+    // open stream
     let mut outbound = TcpStream::connect(proxy_addr).await?;
 
-    // split and merge streams
+    // split, swap and merge streams
     let (mut ri, mut wi) = inbound.split();
     let (mut ro, mut wo) = outbound.split();