diff options
| author | FenrirWolf <[email protected]> | 2018-06-10 11:49:19 -0600 |
|---|---|---|
| committer | GitHub <[email protected]> | 2018-06-10 11:49:19 -0600 |
| commit | 49041a4e56a4cab33ae7889537d33670e8b012fb (patch) | |
| tree | 0c931e8716200f9aa8c7daef47b62474d0285d5c /ctr-std/src/process.rs | |
| parent | Merge pull request #69 from FenrirWolf/libctru-1.5.0 (diff) | |
| parent | Fixes according to Fenrir's review (diff) | |
| download | ctru-rs-49041a4e56a4cab33ae7889537d33670e8b012fb.tar.xz ctru-rs-49041a4e56a4cab33ae7889537d33670e8b012fb.zip | |
Merge pull request #68 from linouxis9/master
Update for latest nightly 2018-05-06
Diffstat (limited to 'ctr-std/src/process.rs')
| -rw-r--r-- | ctr-std/src/process.rs | 13 |
1 files changed, 11 insertions, 2 deletions
diff --git a/ctr-std/src/process.rs b/ctr-std/src/process.rs index 92f0406..00051d4 100644 --- a/ctr-std/src/process.rs +++ b/ctr-std/src/process.rs @@ -1121,8 +1121,13 @@ impl ExitCode { } impl Child { - /// Forces the child to exit. This is equivalent to sending a - /// SIGKILL on unix platforms. + /// Forces the child process to exit. If the child has already exited, an [`InvalidInput`] + /// error is returned. + /// + /// The mapping to [`ErrorKind`]s is not part of the compatibility contract of the function, + /// especially the [`Other`] kind might change to more specific kinds in the future. + /// + /// This is equivalent to sending a SIGKILL on Unix platforms. /// /// # Examples /// @@ -1138,6 +1143,10 @@ impl Child { /// println!("yes command didn't start"); /// } /// ``` + /// + /// [`ErrorKind`]: ../io/enum.ErrorKind.html + /// [`InvalidInput`]: ../io/enum.ErrorKind.html#variant.InvalidInput + /// [`Other`]: ../io/enum.ErrorKind.html#variant.Other #[stable(feature = "process", since = "1.0.0")] pub fn kill(&mut self) -> io::Result<()> { self.handle.kill() |