diff options
Diffstat (limited to 'doc/src/km/status.rs.html')
| -rw-r--r-- | doc/src/km/status.rs.html | 226 |
1 files changed, 226 insertions, 0 deletions
diff --git a/doc/src/km/status.rs.html b/doc/src/km/status.rs.html new file mode 100644 index 0000000..c2fc788 --- /dev/null +++ b/doc/src/km/status.rs.html @@ -0,0 +1,226 @@ +<!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 `status.rs`."> + <meta name="keywords" content="rust, rustlang, rust-lang"> + + <title>status.rs.html -- source</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"> + + + </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 source"><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> +<span id="44">44</span> +<span id="45">45</span> +<span id="46">46</span> +<span id="47">47</span> +<span id="48">48</span> +<span id="49">49</span> +<span id="50">50</span> +<span id="51">51</span> +<span id="52">52</span> +<span id="53">53</span> +<span id="54">54</span> +<span id="55">55</span> +<span id="56">56</span> +<span id="57">57</span> +<span id="58">58</span> +<span id="59">59</span> +</pre><pre class='rust '> +<span class='doccomment'>//! NT Status codes.</span> +<span class='attribute'>#<span class='op'>!</span>[<span class='ident'>allow</span>(<span class='ident'>non_camel_case_types</span>)]</span> +<span class='attribute'>#<span class='op'>!</span>[<span class='ident'>allow</span>(<span class='ident'>overflowing_literals</span>)]</span> + +<span class='doccomment'>/// NT Status type.</span> +<span class='kw'>pub</span> <span class='kw'>type</span> <span class='ident'>NTSTATUS</span> <span class='op'>=</span> <span class='ident'>Status</span>; + +<span class='doccomment'>/// A specialized `Result` type for NT operations.</span> +<span class='kw'>pub</span> <span class='kw'>type</span> <span class='prelude-ty'>Result</span><span class='op'><</span><span class='ident'>T</span><span class='op'>></span> <span class='op'>=</span> ::<span class='ident'>core</span>::<span class='ident'>result</span>::<span class='prelude-ty'>Result</span><span class='op'><</span><span class='ident'>T</span>, <span class='ident'>Status</span><span class='op'>></span>; + + +<span class='doccomment'>/// NT Status code.</span> +<span class='attribute'>#[<span class='ident'>repr</span>(<span class='ident'>C</span>)]</span> +<span class='attribute'>#[<span class='ident'>derive</span>(<span class='ident'>Clone</span>, <span class='ident'>Copy</span>)]</span> +<span class='kw'>pub</span> <span class='kw'>enum</span> <span class='ident'>Status</span> { + <span class='ident'>success</span> <span class='op'>=</span> <span class='number'>0</span>, + <span class='ident'>unsuccessful</span> <span class='op'>=</span> <span class='number'>0xC0000001</span>, +} + +<span class='kw'>impl</span> <span class='ident'>Status</span> { + <span class='doccomment'>/// Evaluates to `true` if the `Status` is a success type (`0..0x3FFFFFFF`)</span> + <span class='doccomment'>/// or an informational type (`0x40000000..0x7FFFFFFF`).</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>is_ok</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>bool</span> { + (<span class='op'>*</span><span class='self'>self</span> <span class='kw'>as</span> <span class='ident'>i32</span>) <span class='op'>>=</span> <span class='number'>0</span> + } + <span class='doccomment'>/// Status is a warning or error type.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>is_err</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>bool</span> { + (<span class='op'>*</span><span class='self'>self</span> <span class='kw'>as</span> <span class='ident'>i32</span>) <span class='op'><</span> <span class='number'>0</span> + } + <span class='doccomment'>/// Status is a success type.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>is_success</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>bool</span> { + <span class='kw'>let</span> <span class='ident'>c</span> <span class='op'>=</span> <span class='op'>*</span><span class='self'>self</span> <span class='kw'>as</span> <span class='ident'>u32</span>; + <span class='ident'>c</span> <span class='op'>></span> <span class='number'>0</span> <span class='op'>&&</span> <span class='ident'>c</span> <span class='op'><</span> <span class='number'>0x3FFF_FFFF</span> + } + <span class='doccomment'>/// Status is a information type.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>is_information</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>bool</span> { + <span class='kw'>let</span> <span class='ident'>c</span> <span class='op'>=</span> <span class='op'>*</span><span class='self'>self</span> <span class='kw'>as</span> <span class='ident'>u32</span>; + <span class='ident'>c</span> <span class='op'>></span> <span class='number'>0x4000_0000</span> <span class='op'>&&</span> <span class='ident'>c</span> <span class='op'><</span> <span class='number'>0x7FFF_FFFF</span> + } + <span class='doccomment'>/// Status is a warning type.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>is_warning</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>bool</span> { + <span class='kw'>let</span> <span class='ident'>c</span> <span class='op'>=</span> <span class='op'>*</span><span class='self'>self</span> <span class='kw'>as</span> <span class='ident'>u32</span>; + <span class='ident'>c</span> <span class='op'>></span> <span class='number'>0x8000_0000</span> <span class='op'>&&</span> <span class='ident'>c</span> <span class='op'><</span> <span class='number'>0xBFFF_FFFF</span> + } + <span class='doccomment'>/// Status is a error type.</span> + <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>is_error</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='ident'>bool</span> { + <span class='kw'>let</span> <span class='ident'>c</span> <span class='op'>=</span> <span class='op'>*</span><span class='self'>self</span> <span class='kw'>as</span> <span class='ident'>u32</span>; + <span class='ident'>c</span> <span class='op'>></span> <span class='number'>0xC000_0000</span> <span class='op'>&&</span> <span class='ident'>c</span> <span class='op'><</span> <span class='number'>0xFFFF_FFFF</span> + } +} + +<span class='doccomment'>/// Convert `Status` to `Result<()>`.</span> +<span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>check</span>(<span class='ident'>st</span>: <span class='ident'>Status</span>) <span class='op'>-></span> <span class='prelude-ty'>Result</span><span class='op'><</span>()<span class='op'>></span> { + <span class='kw'>if</span> <span class='ident'>st</span>.<span class='ident'>is_err</span>() { + <span class='prelude-val'>Err</span>(<span class='ident'>st</span>) + } <span class='kw'>else</span> { + <span class='prelude-val'>Ok</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>⇤</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 = "km"; + window.playgroundUrl = ""; + </script> + <script src="../../jquery.js"></script> + <script src="../../main.js"></script> + + <script defer src="../../search-index.js"></script> +</body> +</html>
\ No newline at end of file |