docstrings

jdockerty · Dec 5, 2023 · b4c56c7 · b4c56c7
1 parent 28ce85f
commit b4c56c7
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/src/http.rs b/src/http.rs
@@ -22,6 +22,10 @@ use tracing::info;
 pub struct HttpProxy {}
 
 impl HttpProxy {
+    // Return a new instance of `HttpProxy`.
+    //
+    // `HttpProxy` has a static lifetime as it exists the entire duration of the
+    // application's active lifecycle.
     pub fn new() -> &'static HttpProxy {
         &Self {}
     }

diff --git a/src/tcp.rs b/src/tcp.rs
@@ -20,6 +20,10 @@ use tracing::info;
 pub struct TcpProxy {}
 
 impl TcpProxy {
+    // Return a new instance of `TcpProxy`.
+    //
+    // `TcpProxy` has a static lifetime as it exists the entire duration of the
+    // application's active lifecycle.
     pub fn new() -> &'static TcpProxy {
         &Self {}
     }