Document unpredictable behaviour of connect()

Ref: servo#378
glyn · Jan 22, 2025 · b79cc38 · b79cc38
1 parent 64fdbfb
commit b79cc38
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/ipc.rs b/src/ipc.rs
@@ -353,6 +353,10 @@ where
 {
     /// Create an [IpcSender] connected to a previously defined [IpcOneShotServer].
     ///
+    /// This function should not be called more than once per [IpcOneShotServer],
+    /// otherwise the behaviour is unpredictable.
+    /// See [issue 378](https://github.com/servo/ipc-channel/issues/378) for details.
+    ///
     /// [IpcSender]: struct.IpcSender.html
     /// [IpcOneShotServer]: struct.IpcOneShotServer.html
     pub fn connect(name: String) -> Result<IpcSender<T>, io::Error> {