unix ExitStatus: Clarify docs for .signal()
We need to be clear that this never returns WSTOPSIG. That is, if WIFSTOPPED, the return value is None. Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
This commit is contained in:
parent
5b1316f781
commit
12d62aa436
1 changed files with 2 additions and 0 deletions
|
@ -171,6 +171,8 @@ pub trait ExitStatusExt {
|
||||||
fn from_raw(raw: i32) -> Self;
|
fn from_raw(raw: i32) -> Self;
|
||||||
|
|
||||||
/// If the process was terminated by a signal, returns that signal.
|
/// If the process was terminated by a signal, returns that signal.
|
||||||
|
///
|
||||||
|
/// Ie, if `WIFSIGNALED`, this returns `WTERMSIG`.
|
||||||
#[stable(feature = "rust1", since = "1.0.0")]
|
#[stable(feature = "rust1", since = "1.0.0")]
|
||||||
fn signal(&self) -> Option<i32>;
|
fn signal(&self) -> Option<i32>;
|
||||||
}
|
}
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue