aboutsummaryrefslogtreecommitdiff
path: root/crates/whirl_server/src/lib.rs
diff options
context:
space:
mode:
authorFuwn <[email protected]>2021-06-06 21:00:22 +0000
committerFuwn <[email protected]>2021-06-06 21:00:22 +0000
commit63df0a38c946f577066604e303f40e3b17073674 (patch)
tree604d7f5e68788c9c2b9937eb39d230d7085450db /crates/whirl_server/src/lib.rs
parentrefactor(whirl_server): move orphan types out of orphan module (diff)
downloadwhirl-63df0a38c946f577066604e303f40e3b17073674.tar.xz
whirl-63df0a38c946f577066604e303f40e3b17073674.zip
docs(whirl_server): document more public functions
Diffstat (limited to 'crates/whirl_server/src/lib.rs')
-rw-r--r--crates/whirl_server/src/lib.rs3
1 files changed, 3 insertions, 0 deletions
diff --git a/crates/whirl_server/src/lib.rs b/crates/whirl_server/src/lib.rs
index 39cbf97..3d66122 100644
--- a/crates/whirl_server/src/lib.rs
+++ b/crates/whirl_server/src/lib.rs
@@ -101,6 +101,9 @@ pub trait Server {
) -> Result<(), Box<dyn Error>>;
}
+/// Spawn and return a vector of thread handles for each sub-server -- which
+/// should be -- instantiated by the `whirl_server` crate.
+///
/// # Panics
/// - A panic may occur if the TCP server is unable to bind the specified port.
#[must_use]