195 lines
No EOL
12 KiB
HTML
195 lines
No EOL
12 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
<meta name="generator" content="rustdoc">
|
||
<meta name="description" content="API documentation for the Rust `Child` struct in crate `bitflags`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, Child">
|
||
|
||
<title>bitflags::__core::process::Child - Rust</title>
|
||
|
||
<link rel="stylesheet" type="text/css" href="../../../rustdoc.css">
|
||
<link rel="stylesheet" type="text/css" href="../../../main.css">
|
||
|
||
|
||
|
||
|
||
</head>
|
||
<body class="rustdoc">
|
||
<!--[if lte IE 8]>
|
||
<div class="warning">
|
||
This old browser is unsupported and will most likely display funky
|
||
things.
|
||
</div>
|
||
<![endif]-->
|
||
|
||
|
||
|
||
<nav class="sidebar">
|
||
|
||
<p class='location'><a href='../../index.html'>bitflags</a>::<wbr><a href='../index.html'>__core</a>::<wbr><a href='index.html'>process</a></p><script>window.sidebarCurrent = {name: 'Child', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script>
|
||
</nav>
|
||
|
||
<nav class="sub">
|
||
<form class="search-form js-only">
|
||
<div class="search-container">
|
||
<input class="search-input" name="search"
|
||
autocomplete="off"
|
||
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
|
||
type="search">
|
||
</div>
|
||
</form>
|
||
</nav>
|
||
|
||
<section id='main' class="content struct">
|
||
<h1 class='fqn'><span class='in-band'>Struct <a href='../../index.html'>bitflags</a>::<wbr><a href='../index.html'>__core</a>::<wbr><a href='index.html'>process</a>::<wbr><a class='struct' href=''>Child</a></span><span class='out-of-band'><span id='render-detail'>
|
||
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
|
||
[<span class='inner'>−</span>]
|
||
</a>
|
||
</span><a id='src-8260' class='srclink' href='https://doc.rust-lang.org/nightly/std/process/struct.Child.html?gotosrc=8260' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust struct'>pub struct Child {
|
||
pub stdin: <a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a><<a class='struct' href='../../../bitflags/__core/process/struct.ChildStdin.html' title='bitflags::__core::process::ChildStdin'>ChildStdin</a>>,
|
||
pub stdout: <a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a><<a class='struct' href='../../../bitflags/__core/process/struct.ChildStdout.html' title='bitflags::__core::process::ChildStdout'>ChildStdout</a>>,
|
||
pub stderr: <a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a><<a class='struct' href='../../../bitflags/__core/process/struct.ChildStderr.html' title='bitflags::__core::process::ChildStderr'>ChildStderr</a>>,
|
||
// some fields omitted
|
||
}</pre><span class="since">1.0.0</span><div class='docblock'><p>Representation of a running or exited child process.</p>
|
||
|
||
<p>This structure is used to represent and manage child processes. A child
|
||
process is created via the <code>Command</code> struct, which configures the spawning
|
||
process and can itself be constructed using a builder-style interface.</p>
|
||
|
||
<h1 id='examples' class='section-header'><a href='#examples'>Examples</a></h1>
|
||
<pre class='rust rust-example-rendered'>
|
||
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>process</span>::<span class='ident'>Command</span>;
|
||
|
||
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>child</span> <span class='op'>=</span> <span class='ident'>Command</span>::<span class='ident'>new</span>(<span class='string'>"/bin/cat"</span>)
|
||
.<span class='ident'>arg</span>(<span class='string'>"file.txt"</span>)
|
||
.<span class='ident'>spawn</span>()
|
||
.<span class='ident'>expect</span>(<span class='string'>"failed to execute child"</span>);
|
||
|
||
<span class='kw'>let</span> <span class='ident'>ecode</span> <span class='op'>=</span> <span class='ident'>child</span>.<span class='ident'>wait</span>()
|
||
.<span class='ident'>expect</span>(<span class='string'>"failed to wait on child"</span>);
|
||
|
||
<span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>ecode</span>.<span class='ident'>success</span>());</pre>
|
||
|
||
<h1 id='note' class='section-header'><a href='#note'>Note</a></h1>
|
||
<p>Take note that there is no implementation of
|
||
<a href="../../core/ops/trait.Drop.html"><code>Drop</code></a> for child processes, so if you
|
||
do not ensure the <code>Child</code> has exited then it will continue to run, even
|
||
after the <code>Child</code> handle to the child process has gone out of scope.</p>
|
||
|
||
<p>Calling <code>wait</code> (or other functions that wrap around it) will make the
|
||
parent process wait until the child has actually exited before continuing.</p>
|
||
</div><h2 class='fields'>Fields</h2>
|
||
<table><tr class='stab '>
|
||
<td id='structfield.stdin'><code>stdin</code></td><td><div class='docblock'><p>The handle for writing to the child's stdin, if it has been captured</p>
|
||
</div></td></tr><tr class='stab '>
|
||
<td id='structfield.stdout'><code>stdout</code></td><td><div class='docblock'><p>The handle for reading from the child's stdout, if it has been captured</p>
|
||
</div></td></tr><tr class='stab '>
|
||
<td id='structfield.stderr'><code>stderr</code></td><td><div class='docblock'><p>The handle for reading from the child's stderr, if it has been captured</p>
|
||
</div></td></tr></table><h2 id='methods'>Methods</h2><h3 class='impl'><code>impl <a class='struct' href='../../../bitflags/__core/process/struct.Child.html' title='bitflags::__core::process::Child'>Child</a></code></h3><div class='impl-items'><h4 id='method.kill' class='method'><code>fn <a href='#method.kill' class='fnname'>kill</a>(&mut self) -> <a class='enum' href='../../../bitflags/__core/result/enum.Result.html' title='bitflags::__core::result::Result'>Result</a><<a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.tuple.html'>()</a>, <a class='struct' href='../../../bitflags/__core/io/struct.Error.html' title='bitflags::__core::io::Error'>Error</a>></code></h4>
|
||
<div class='docblock'><p>Forces the child to exit. This is equivalent to sending a
|
||
SIGKILL on unix platforms.</p>
|
||
</div><h4 id='method.id' class='method'><code>fn <a href='#method.id' class='fnname'>id</a>(&self) -> <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.u32.html'>u32</a></code><span class="since">1.3.0</span></h4>
|
||
<div class='docblock'><p>Returns the OS-assigned process identifier associated with this child.</p>
|
||
</div><h4 id='method.wait' class='method'><code>fn <a href='#method.wait' class='fnname'>wait</a>(&mut self) -> <a class='enum' href='../../../bitflags/__core/result/enum.Result.html' title='bitflags::__core::result::Result'>Result</a><<a class='struct' href='../../../bitflags/__core/process/struct.ExitStatus.html' title='bitflags::__core::process::ExitStatus'>ExitStatus</a>, <a class='struct' href='../../../bitflags/__core/io/struct.Error.html' title='bitflags::__core::io::Error'>Error</a>></code></h4>
|
||
<div class='docblock'><p>Waits for the child to exit completely, returning the status that it
|
||
exited with. This function will continue to have the same return value
|
||
after it has been called at least once.</p>
|
||
|
||
<p>The stdin handle to the child process, if any, will be closed
|
||
before waiting. This helps avoid deadlock: it ensures that the
|
||
child does not block waiting for input from the parent, while
|
||
the parent waits for the child to exit.</p>
|
||
</div><h4 id='method.wait_with_output' class='method'><code>fn <a href='#method.wait_with_output' class='fnname'>wait_with_output</a>(self) -> <a class='enum' href='../../../bitflags/__core/result/enum.Result.html' title='bitflags::__core::result::Result'>Result</a><<a class='struct' href='../../../bitflags/__core/process/struct.Output.html' title='bitflags::__core::process::Output'>Output</a>, <a class='struct' href='../../../bitflags/__core/io/struct.Error.html' title='bitflags::__core::io::Error'>Error</a>></code></h4>
|
||
<div class='docblock'><p>Simultaneously waits for the child to exit and collect all remaining
|
||
output on the stdout/stderr handles, returning an <code>Output</code>
|
||
instance.</p>
|
||
|
||
<p>The stdin handle to the child process, if any, will be closed
|
||
before waiting. This helps avoid deadlock: it ensures that the
|
||
child does not block waiting for input from the parent, while
|
||
the parent waits for the child to exit.</p>
|
||
|
||
<p>By default, stdin, stdout and stderr are inherited from the parent.
|
||
In order to capture the output into this <code>Result<Output></code> it is
|
||
necessary to create new pipes between parent and child. Use
|
||
<code>stdout(Stdio::piped())</code> or <code>stderr(Stdio::piped())</code>, respectively.</p>
|
||
|
||
<h1 id='examples-1' class='section-header'><a href='#examples-1'>Examples</a></h1>
|
||
<pre class='rust rust-example-rendered'>
|
||
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>process</span>::{<span class='ident'>Command</span>, <span class='ident'>Stdio</span>};
|
||
|
||
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>child</span> <span class='op'>=</span> <span class='ident'>Command</span>::<span class='ident'>new</span>(<span class='string'>"/bin/cat"</span>)
|
||
.<span class='ident'>arg</span>(<span class='string'>"file.txt"</span>)
|
||
.<span class='ident'>stdout</span>(<span class='ident'>Stdio</span>::<span class='ident'>piped</span>())
|
||
.<span class='ident'>spawn</span>()
|
||
.<span class='ident'>expect</span>(<span class='string'>"failed to execute child"</span>);
|
||
|
||
<span class='kw'>let</span> <span class='ident'>ecode</span> <span class='op'>=</span> <span class='ident'>child</span>.<span class='ident'>wait_with_output</span>()
|
||
.<span class='ident'>expect</span>(<span class='string'>"failed to wait on child"</span>);
|
||
|
||
<span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>ecode</span>.<span class='ident'>status</span>.<span class='ident'>success</span>());</pre>
|
||
</div></div></section>
|
||
<section id='search' class="content hidden"></section>
|
||
|
||
<section class="footer"></section>
|
||
|
||
<aside id="help" class="hidden">
|
||
<div>
|
||
<h1 class="hidden">Help</h1>
|
||
|
||
<div class="shortcuts">
|
||
<h2>Keyboard Shortcuts</h2>
|
||
|
||
<dl>
|
||
<dt>?</dt>
|
||
<dd>Show this help dialog</dd>
|
||
<dt>S</dt>
|
||
<dd>Focus the search field</dd>
|
||
<dt>⇤</dt>
|
||
<dd>Move up in search results</dd>
|
||
<dt>⇥</dt>
|
||
<dd>Move down in search results</dd>
|
||
<dt>⏎</dt>
|
||
<dd>Go to active search result</dd>
|
||
</dl>
|
||
</div>
|
||
|
||
<div class="infos">
|
||
<h2>Search Tricks</h2>
|
||
|
||
<p>
|
||
Prefix searches with a type followed by a colon (e.g.
|
||
<code>fn:</code>) to restrict the search to a given type.
|
||
</p>
|
||
|
||
<p>
|
||
Accepted types are: <code>fn</code>, <code>mod</code>,
|
||
<code>struct</code>, <code>enum</code>,
|
||
<code>trait</code>, <code>type</code>, <code>macro</code>,
|
||
and <code>const</code>.
|
||
</p>
|
||
|
||
<p>
|
||
Search functions by type signature (e.g.
|
||
<code>vec -> usize</code> or <code>* -> vec</code>)
|
||
</p>
|
||
</div>
|
||
</div>
|
||
</aside>
|
||
|
||
|
||
|
||
<script>
|
||
window.rootPath = "../../../";
|
||
window.currentCrate = "bitflags";
|
||
window.playgroundUrl = "";
|
||
</script>
|
||
<script src="../../../jquery.js"></script>
|
||
<script src="../../../main.js"></script>
|
||
|
||
<script defer src="../../../search-index.js"></script>
|
||
</body>
|
||
</html> |