add docs on LocalServerTask

SeaDve · Sep 17, 2023 · d221008 · d221008
1 parent f36b48e
commit d221008
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/local_server.rs b/src/local_server.rs
@@ -486,6 +486,10 @@ where
     }
 }
 
+/// A task that initializes the connection and run the server until the server
+/// and the task is dropped.
+///
+/// This must be awaited as soon as possible after creating the server.
 #[must_use = "futures do nothing unless you `.await` or poll them"]
 pub struct LocalServerTask {
     inner: Option<Pin<Box<dyn Future<Output = Result<()>>>>>,