aboutsummaryrefslogtreecommitdiff
path: root/crates/whirl_server/src/lib.rs
diff options
context:
space:
mode:
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]