about summary refs log tree commit diff
path: root/src/libstd/process.rs
diff options
context:
space:
mode:
authorAlex Crichton <alex@alexcrichton.com>2015-03-31 14:41:59 -0700
committerAlex Crichton <alex@alexcrichton.com>2015-03-31 14:46:11 -0700
commit71982aa65725a2e630b3abdbb5f48e1abf1acf91 (patch)
treed90f4cf1e4464e949d155cd7e540f3889e287cf3 /src/libstd/process.rs
parent80bf31dd514055177b22c3dc66836d39eb5b1648 (diff)
downloadrust-71982aa65725a2e630b3abdbb5f48e1abf1acf91.tar.gz
rust-71982aa65725a2e630b3abdbb5f48e1abf1acf91.zip
std: Add a process::exit function
This commit is an implementation of [RFC #1011][rfc] which adds an `exit`
function to the standard library for immediately terminating the current process
with a specified exit code.

[rfc]: https://github.com/rust-lang/rfcs/pull/1011
Diffstat (limited to 'src/libstd/process.rs')
-rw-r--r--src/libstd/process.rs16
1 files changed, 16 insertions, 0 deletions
diff --git a/src/libstd/process.rs b/src/libstd/process.rs
index b4bd513e8f0..5f29275df1f 100644
--- a/src/libstd/process.rs
+++ b/src/libstd/process.rs
@@ -527,6 +527,22 @@ impl Child {
     }
 }
 
+/// Terminates the current process with the specified exit code.
+///
+/// This function will never return and will immediately terminate the current
+/// process. The exit code is passed through to the underlying OS and will be
+/// available for consumption by another process.
+///
+/// Note that because this function never returns, and that it terminates the
+/// process, no destructors on the current stack or any other thread's stack
+/// will be run. If a clean shutdown is needed it is recommended to only call
+/// this function at a known point where there are no more destructors left
+/// to run.
+#[stable(feature = "rust1", since = "1.0.0")]
+pub fn exit(code: i32) -> ! {
+    ::sys::os::exit(code)
+}
+
 #[cfg(test)]
 mod tests {
     use io::ErrorKind;