Indicate how ChildStd{in,out,err} FDs are closed.

Fixes https://github.com/rust-lang/rust/issues/41452.
This commit is contained in:
Corey Farwell 2017-09-15 22:57:12 -04:00
parent fd4bef54ab
commit a6ef99e9f4

View File

@ -153,8 +153,12 @@ impl fmt::Debug for Child {
/// ///
/// This struct is used in the [`stdin`] field on [`Child`]. /// This struct is used in the [`stdin`] field on [`Child`].
/// ///
/// When an instance of `ChildStdin` is [dropped], the `ChildStdin`'s underlying
/// file handle will be closed.
///
/// [`Child`]: struct.Child.html /// [`Child`]: struct.Child.html
/// [`stdin`]: struct.Child.html#structfield.stdin /// [`stdin`]: struct.Child.html#structfield.stdin
/// [dropped]: ../ops/trait.Drop.html
#[stable(feature = "process", since = "1.0.0")] #[stable(feature = "process", since = "1.0.0")]
pub struct ChildStdin { pub struct ChildStdin {
inner: AnonPipe inner: AnonPipe
@ -196,8 +200,12 @@ impl fmt::Debug for ChildStdin {
/// ///
/// This struct is used in the [`stdout`] field on [`Child`]. /// This struct is used in the [`stdout`] field on [`Child`].
/// ///
/// When an instance of `ChildStdout` is [dropped], the `ChildStdout`'s
/// underlying file handle will be closed.
///
/// [`Child`]: struct.Child.html /// [`Child`]: struct.Child.html
/// [`stdout`]: struct.Child.html#structfield.stdout /// [`stdout`]: struct.Child.html#structfield.stdout
/// [dropped]: ../ops/trait.Drop.html
#[stable(feature = "process", since = "1.0.0")] #[stable(feature = "process", since = "1.0.0")]
pub struct ChildStdout { pub struct ChildStdout {
inner: AnonPipe inner: AnonPipe
@ -239,8 +247,12 @@ impl fmt::Debug for ChildStdout {
/// ///
/// This struct is used in the [`stderr`] field on [`Child`]. /// This struct is used in the [`stderr`] field on [`Child`].
/// ///
/// When an instance of `ChildStderr` is [dropped], the `ChildStderr`'s
/// underlying file handle will be closed.
///
/// [`Child`]: struct.Child.html /// [`Child`]: struct.Child.html
/// [`stderr`]: struct.Child.html#structfield.stderr /// [`stderr`]: struct.Child.html#structfield.stderr
/// [dropped]: ../ops/trait.Drop.html
#[stable(feature = "process", since = "1.0.0")] #[stable(feature = "process", since = "1.0.0")]
pub struct ChildStderr { pub struct ChildStderr {
inner: AnonPipe inner: AnonPipe