Переглянути джерело

Add documentation for RaftJoinHandler::join().

Jing Yang 3 роки тому
батько
коміт
914409a197
1 змінених файлів з 3 додано та 0 видалено
  1. 3 0
      src/raft.rs

+ 3 - 0
src/raft.rs

@@ -239,6 +239,9 @@ impl RaftJoinHandle {
     const SHUTDOWN_TIMEOUT: Duration =
         Duration::from_millis(HEARTBEAT_INTERVAL.as_millis() as u64 * 2);
 
+    /// Waits for the Raft instance to shutdown.
+    ///
+    /// See the struct documentation for more details.
     pub fn join(self) {
         // Wait for all Raft instances to be dropped.
         self.stop_wait_group.wait();