blob: 9663d5d492af9be48d2e2955c64eafade1a7bf6c [file] [log] [blame]
<!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 `ForkResult` enum in crate `nix`.">
<meta name="keywords" content="rust, rustlang, rust-lang, ForkResult">
<title>nix::unistd::ForkResult - Rust</title>
<link rel="stylesheet" type="text/css" href="../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../../main.css">
</head>
<body class="rustdoc enum">
<!--[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'>Enum ForkResult</p><div class="block items"><ul><li><a href="#variants">Variants</a></li><li><a href="#methods">Methods</a></li><li><a href="#implementations">Trait Implementations</a></li></ul></div><p class='location'><a href='../index.html'>nix</a>::<wbr><a href='index.html'>unistd</a></p><script>window.sidebarCurrent = {name: 'ForkResult', ty: 'enum', 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">
<h1 class='fqn'><span class='in-band'>Enum <a href='../index.html'>nix</a>::<wbr><a href='index.html'>unistd</a>::<wbr><a class="enum" href=''>ForkResult</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'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../../src/nix/unistd.rs.html#24-27' title='goto source code'>[src]</a></span></h1>
<pre class='rust enum'>pub enum ForkResult {
Parent {
child: <a class="type" href="../../libc/unix/type.pid_t.html" title="type libc::unix::pid_t">pid_t</a>,
},
Child,
}</pre><div class='docblock'><p>Represents the successful result of calling <code>fork</code></p>
<p>When <code>fork</code> is called, the process continues execution in the parent process
and in the new child. This return type can be examined to determine whether
you are now executing in the parent process or in the child.</p>
</div><h2 id='variants' class='variants small-section-header'>
Variants<a href='#variants' class='anchor'></a></h2>
<span id='variant.Parent' class='variant'><span id='Parent.v' class='invisible'><code>Parent</code></span></span><span class='docblock autohide sub-variant' id='variant.Parent.fields'><h3 class='fields'>Fields of <code>Parent</code></h3>
<table><tr><td id='variant.Parent.field.child'><span id='Parent.v.child.v' class='invisible'><code>child:&nbsp;<a class="type" href="../../libc/unix/type.pid_t.html" title="type libc::unix::pid_t">pid_t</a></code></span></td><td></td></tr></table></span><span id='variant.Child' class='variant'><span id='Child.v' class='invisible'><code>Child</code></span></span>
<h2 id='methods' class='small-section-header'>
Methods<a href='#methods' class='anchor'></a>
</h2>
<h3 class='impl'><span class='in-band'><code>impl <a class="enum" href="../../nix/unistd/enum.ForkResult.html" title="enum nix::unistd::ForkResult">ForkResult</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/nix/unistd.rs.html#29-45' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.is_child' class="method"><span id='is_child.v' class='invisible'><code>fn <a href='#method.is_child' class='fnname'>is_child</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/nix/unistd.rs.html#33-38' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Return <code>true</code> if this is the child process of the <code>fork()</code></p>
</div><h4 id='method.is_parent' class="method"><span id='is_parent.v' class='invisible'><code>fn <a href='#method.is_parent' class='fnname'>is_parent</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/nix/unistd.rs.html#42-44' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns <code>true</code> if this is the parent process of the <code>fork()</code></p>
</div></div>
<h2 id='implementations' class='small-section-header'>
Trait Implementations<a href='#implementations' class='anchor'></a>
</h2>
<h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="enum" href="../../nix/unistd/enum.ForkResult.html" title="enum nix::unistd::ForkResult">ForkResult</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/nix/unistd.rs.html#23' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&amp;self) -&gt; <a class="enum" href="../../nix/unistd/enum.ForkResult.html" title="enum nix::unistd::ForkResult">ForkResult</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/nix/unistd.rs.html#23' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&amp;mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self)</code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#112-114' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> for <a class="enum" href="../../nix/unistd/enum.ForkResult.html" title="enum nix::unistd::ForkResult">ForkResult</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/nix/unistd.rs.html#23' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'></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>&larrb;</dt>
<dd>Move up in search results</dd>
<dt>&rarrb;</dt>
<dd>Move down in search results</dd>
<dt>&#9166;</dt>
<dd>Go to active search result</dd>
<dt>+</dt>
<dd>Collapse/expand all sections</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 = "nix";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>