Document unpredictable behaviour of connect() (#379)

Ref: #378
servo · Jan 24, 2025 · 907d1ae · 907d1ae
1 parent 64fdbfb
commit 907d1ae
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> {