about summary refs log tree commit diff
path: root/src/libstd/io/process.rs
diff options
context:
space:
mode:
authorAlex Crichton <alex@alexcrichton.com>2014-05-30 17:18:12 -0700
committerAlex Crichton <alex@alexcrichton.com>2014-06-16 10:47:25 -0700
commit2fe926431bb198a052a5eae92ff820a4f572fd92 (patch)
treeec39df7109eee720e694224a0929605443a46b96 /src/libstd/io/process.rs
parent0b32d42a5da84c1f23a2b50b9a6741eea69773c4 (diff)
downloadrust-2fe926431bb198a052a5eae92ff820a4f572fd92.tar.gz
rust-2fe926431bb198a052a5eae92ff820a4f572fd92.zip
std: Support consuming a Process without waiting
Forking off a child which survives the parent is often a useful task, and is
currently not possible because the Process type will invoke `wait()` in its
destructor in order to prevent leaking resources. This function adds a new safe
method, `forget`, which can be used to consume an instance of `Process` which
will then not call `wait` in the destructor.

This new method is clearly documented as a leak of resources, but it must be
forcibly opted in to.

Closes #14467
Diffstat (limited to 'src/libstd/io/process.rs')
-rw-r--r--src/libstd/io/process.rs23
1 files changed, 23 insertions, 0 deletions
diff --git a/src/libstd/io/process.rs b/src/libstd/io/process.rs
index 38d8475ddf7..1dcf08b2322 100644
--- a/src/libstd/io/process.rs
+++ b/src/libstd/io/process.rs
@@ -59,6 +59,7 @@ use c_str::CString;
 /// ```
 pub struct Process {
     handle: Box<RtioProcess + Send>,
+    forget: bool,
 
     /// Handle to the child's stdin, if the `stdin` field of this process's
     /// `ProcessConfig` was `CreatePipe`. By default, this handle is `Some`.
@@ -262,6 +263,7 @@ impl Command {
                 });
                 Process {
                     handle: p,
+                    forget: false,
                     stdin: io.next().unwrap(),
                     stdout: io.next().unwrap(),
                     stderr: io.next().unwrap(),
@@ -540,10 +542,23 @@ impl Process {
             error:  stderr.recv().ok().unwrap_or(Vec::new()),
         })
     }
+
+    /// Forgets this process, allowing it to outlive the parent
+    ///
+    /// This function will forcefully prevent calling `wait()` on the child
+    /// process in the destructor, allowing the child to outlive the
+    /// parent. Note that this operation can easily lead to leaking the
+    /// resources of the child process, so care must be taken when
+    /// invoking this method.
+    pub fn forget(mut self) {
+        self.forget = true;
+    }
 }
 
 impl Drop for Process {
     fn drop(&mut self) {
+        if self.forget { return }
+
         // Close all I/O before exiting to ensure that the child doesn't wait
         // forever to print some text or something similar.
         drop(self.stdin.take());
@@ -933,4 +948,12 @@ mod tests {
         rx.recv();
         rx.recv();
     })
+
+    iotest!(fn forget() {
+        let p = sleeper();
+        let id = p.id();
+        p.forget();
+        assert!(Process::kill(id, 0).is_ok());
+        assert!(Process::kill(id, PleaseExitSignal).is_ok());
+    })
 }