blob: f5b8d0a641edf2c80ea85c2dc92cb028e5e105a0 [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="Source to the Rust file `/home/travis/.cargo/registry/src/github.com-1ecc6299db9ec823/nix-0.8.1/src/sys/reboot.rs`.">
<meta name="keywords" content="rust, rustlang, rust-lang">
<title>reboot.rs.html -- source</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 source">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
</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"><pre class="line-numbers"><span id="1"> 1</span>
<span id="2"> 2</span>
<span id="3"> 3</span>
<span id="4"> 4</span>
<span id="5"> 5</span>
<span id="6"> 6</span>
<span id="7"> 7</span>
<span id="8"> 8</span>
<span id="9"> 9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
</pre><pre class="rust ">
<span class="doccomment">//! Reboot/shutdown or enable/disable Ctrl-Alt-Delete.</span>
<span class="kw">use</span> {<span class="ident">Errno</span>, <span class="ident">Error</span>, <span class="prelude-ty">Result</span>};
<span class="kw">use</span> <span class="ident">libc</span>;
<span class="kw">use</span> <span class="ident">void</span>::<span class="ident">Void</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">mem</span>::<span class="ident">drop</span>;
<span class="doccomment">/// How exactly should the system be rebooted.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// See [`set_cad_enabled()`](fn.set_cad_enabled.html) for</span>
<span class="doccomment">/// enabling/disabling Ctrl-Alt-Delete.</span>
<span class="attribute">#[<span class="ident">repr</span>(<span class="ident">i32</span>)]</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">Copy</span>, <span class="ident">Debug</span>, <span class="ident">Eq</span>, <span class="ident">PartialEq</span>)]</span>
<span class="kw">pub</span> <span class="kw">enum</span> <span class="ident">RebootMode</span> {
<span class="ident">RB_HALT_SYSTEM</span> <span class="op">=</span> <span class="ident">libc</span>::<span class="ident">RB_HALT_SYSTEM</span>,
<span class="ident">RB_KEXEC</span> <span class="op">=</span> <span class="ident">libc</span>::<span class="ident">RB_KEXEC</span>,
<span class="ident">RB_POWER_OFF</span> <span class="op">=</span> <span class="ident">libc</span>::<span class="ident">RB_POWER_OFF</span>,
<span class="ident">RB_AUTOBOOT</span> <span class="op">=</span> <span class="ident">libc</span>::<span class="ident">RB_AUTOBOOT</span>,
<span class="comment">// we do not support Restart2,</span>
<span class="ident">RB_SW_SUSPEND</span> <span class="op">=</span> <span class="ident">libc</span>::<span class="ident">RB_SW_SUSPEND</span>,
}
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">reboot</span>(<span class="ident">how</span>: <span class="ident">RebootMode</span>) <span class="op">-&gt;</span> <span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="ident">Void</span><span class="op">&gt;</span> {
<span class="kw">unsafe</span> {
<span class="ident">libc</span>::<span class="ident">reboot</span>(<span class="ident">how</span> <span class="kw">as</span> <span class="ident">libc</span>::<span class="ident">c_int</span>)
};
<span class="prelude-val">Err</span>(<span class="ident">Error</span>::<span class="ident">Sys</span>(<span class="ident">Errno</span>::<span class="ident">last</span>()))
}
<span class="doccomment">/// Enable or disable the reboot keystroke (Ctrl-Alt-Delete).</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Corresponds to calling `reboot(RB_ENABLE_CAD)` or `reboot(RB_DISABLE_CAD)` in C.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_cad_enabled</span>(<span class="ident">enable</span>: <span class="ident">bool</span>) <span class="op">-&gt;</span> <span class="prelude-ty">Result</span><span class="op">&lt;</span>()<span class="op">&gt;</span> {
<span class="kw">let</span> <span class="ident">cmd</span> <span class="op">=</span> <span class="kw">if</span> <span class="ident">enable</span> {
<span class="ident">libc</span>::<span class="ident">RB_ENABLE_CAD</span>
} <span class="kw">else</span> {
<span class="ident">libc</span>::<span class="ident">RB_DISABLE_CAD</span>
};
<span class="kw">let</span> <span class="ident">res</span> <span class="op">=</span> <span class="kw">unsafe</span> {
<span class="ident">libc</span>::<span class="ident">reboot</span>(<span class="ident">cmd</span>)
};
<span class="ident">Errno</span>::<span class="ident">result</span>(<span class="ident">res</span>).<span class="ident">map</span>(<span class="ident">drop</span>)
}
</pre>
</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>