aboutsummaryrefslogtreecommitdiff
path: root/doc/src/km/string.rs.html
diff options
context:
space:
mode:
authorpravic <[email protected]>2016-04-12 18:12:52 +0300
committerpravic <[email protected]>2016-04-12 18:12:52 +0300
commit24af17846d14b290aa1d90e37e98c4cbe9e173e1 (patch)
treed68362060a430c72f19a46ec382f070cf0cbefe5 /doc/src/km/string.rs.html
parentadd index (diff)
downloadwinapi-kmd-rs-24af17846d14b290aa1d90e37e98c4cbe9e173e1.tar.xz
winapi-kmd-rs-24af17846d14b290aa1d90e37e98c4cbe9e173e1.zip
add winapi-km-rs docs
Diffstat (limited to 'doc/src/km/string.rs.html')
-rw-r--r--doc/src/km/string.rs.html298
1 files changed, 298 insertions, 0 deletions
diff --git a/doc/src/km/string.rs.html b/doc/src/km/string.rs.html
new file mode 100644
index 0000000..df79ed1
--- /dev/null
+++ b/doc/src/km/string.rs.html
@@ -0,0 +1,298 @@
+<!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 `string.rs`.">
+ <meta name="keywords" content="rust, rustlang, rust-lang">
+
+ <title>string.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>
+<span id="60">60</span>
+<span id="61">61</span>
+<span id="62">62</span>
+<span id="63">63</span>
+<span id="64">64</span>
+<span id="65">65</span>
+<span id="66">66</span>
+<span id="67">67</span>
+<span id="68">68</span>
+<span id="69">69</span>
+<span id="70">70</span>
+<span id="71">71</span>
+<span id="72">72</span>
+<span id="73">73</span>
+<span id="74">74</span>
+<span id="75">75</span>
+<span id="76">76</span>
+<span id="77">77</span>
+<span id="78">78</span>
+<span id="79">79</span>
+<span id="80">80</span>
+<span id="81">81</span>
+<span id="82">82</span>
+<span id="83">83</span>
+<span id="84">84</span>
+<span id="85">85</span>
+<span id="86">86</span>
+<span id="87">87</span>
+<span id="88">88</span>
+<span id="89">89</span>
+<span id="90">90</span>
+<span id="91">91</span>
+<span id="92">92</span>
+<span id="93">93</span>
+<span id="94">94</span>
+<span id="95">95</span>
+</pre><pre class='rust '>
+<span class='doccomment'>//! Kernel mode string types.</span>
+
+<span class='kw'>use</span> ::<span class='ident'>NTSTATUS</span>;
+
+<span class='doccomment'>/// NT native string types.</span>
+<span class='kw'>pub</span> <span class='kw'>trait</span> <span class='ident'>NativeString</span> {
+ <span class='doccomment'>/// Size of string in bytes.</span>
+ <span class='kw'>fn</span> <span class='ident'>size</span>(<span class='kw-2'>&amp;</span><span class='self'>self</span>) <span class='op'>-&gt;</span> <span class='ident'>u16</span>;
+ <span class='doccomment'>/// Size of buffer in bytes.</span>
+ <span class='kw'>fn</span> <span class='ident'>max_size</span>(<span class='kw-2'>&amp;</span><span class='self'>self</span>) <span class='op'>-&gt;</span> <span class='ident'>u16</span>;
+
+ <span class='doccomment'>/// Check is the string is empty.</span>
+ <span class='kw'>fn</span> <span class='ident'>is_empty</span>(<span class='kw-2'>&amp;</span><span class='self'>self</span>) <span class='op'>-&gt;</span> <span class='ident'>bool</span> {
+ <span class='self'>self</span>.<span class='ident'>size</span>() <span class='op'>==</span> <span class='number'>0u16</span>
+ }
+}
+
+<span class='doccomment'>/// A counted Unicode string.</span>
+<span class='attribute'>#[<span class='ident'>repr</span>(<span class='ident'>C</span>)]</span>
+<span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>UNICODE_STRING</span>
+{
+ <span class='doccomment'>/// The length in **bytes** of the string stored in `Buffer`.</span>
+ <span class='kw'>pub</span> <span class='ident'>Length</span>: <span class='ident'>u16</span>,
+ <span class='doccomment'>/// The length in **bytes** of `Buffer`.</span>
+ <span class='kw'>pub</span> <span class='ident'>MaximumLength</span>: <span class='ident'>u16</span>,
+ <span class='doccomment'>/// Pointer to a buffer used to contain a string of wide characters.</span>
+ <span class='kw'>pub</span> <span class='ident'>Buffer</span>: <span class='op'>*</span><span class='kw'>const</span> <span class='ident'>u16</span>,
+}
+
+<span class='doccomment'>/// A counted string used for ANSI strings.</span>
+<span class='attribute'>#[<span class='ident'>repr</span>(<span class='ident'>C</span>)]</span>
+<span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>ANSI_STRING</span>
+{
+ <span class='doccomment'>/// The length in *bytes* of the string stored in `Buffer`.</span>
+ <span class='kw'>pub</span> <span class='ident'>Length</span>: <span class='ident'>u16</span>,
+ <span class='doccomment'>/// The length in bytes of `Buffer`.</span>
+ <span class='kw'>pub</span> <span class='ident'>MaximumLength</span>: <span class='ident'>u16</span>,
+ <span class='doccomment'>/// Pointer to a buffer used to contain a string of characters.</span>
+ <span class='kw'>pub</span> <span class='ident'>Buffer</span>: <span class='op'>*</span><span class='kw'>const</span> <span class='ident'>u8</span>,
+}
+
+<span class='kw'>impl</span> <span class='ident'>NativeString</span> <span class='kw'>for</span> <span class='ident'>UNICODE_STRING</span>
+{
+ <span class='kw'>fn</span> <span class='ident'>size</span>(<span class='kw-2'>&amp;</span><span class='self'>self</span>) <span class='op'>-&gt;</span> <span class='ident'>u16</span> { <span class='self'>self</span>.<span class='ident'>Length</span> }
+ <span class='kw'>fn</span> <span class='ident'>max_size</span>(<span class='kw-2'>&amp;</span><span class='self'>self</span>) <span class='op'>-&gt;</span> <span class='ident'>u16</span> { <span class='self'>self</span>.<span class='ident'>MaximumLength</span> }
+}
+
+<span class='kw'>impl</span> <span class='ident'>UNICODE_STRING</span>
+{
+}
+
+<span class='doccomment'>/// Initializes a counted Unicode string.</span>
+<span class='kw'>impl</span> <span class='ident'>Default</span> <span class='kw'>for</span> <span class='ident'>UNICODE_STRING</span> {
+ <span class='kw'>fn</span> <span class='ident'>default</span>() <span class='op'>-&gt;</span> <span class='kw'>Self</span> {
+ <span class='ident'>UNICODE_STRING</span> { <span class='ident'>Length</span>: <span class='number'>0</span>, <span class='ident'>MaximumLength</span>: <span class='number'>0</span>, <span class='ident'>Buffer</span>: ::<span class='ident'>core</span>::<span class='ident'>ptr</span>::<span class='ident'>null</span>() }
+ }
+}
+
+<span class='kw'>impl</span><span class='op'>&lt;</span><span class='lifetime'>&#39;a</span><span class='op'>&gt;</span> <span class='ident'>From</span><span class='op'>&lt;</span><span class='kw-2'>&amp;</span><span class='lifetime'>&#39;a</span> [<span class='ident'>u8</span>]<span class='op'>&gt;</span> <span class='kw'>for</span> <span class='ident'>ANSI_STRING</span> {
+ <span class='kw'>fn</span> <span class='ident'>from</span>(<span class='ident'>s</span>: <span class='kw-2'>&amp;</span><span class='lifetime'>&#39;a</span> [<span class='ident'>u8</span>]) <span class='op'>-&gt;</span> <span class='kw'>Self</span> {
+ <span class='kw'>let</span> <span class='ident'>len</span> <span class='op'>=</span> <span class='ident'>s</span>.<span class='ident'>len</span>();
+ <span class='kw'>let</span> <span class='ident'>n</span> <span class='op'>=</span> <span class='kw'>if</span> <span class='ident'>len</span> <span class='op'>&gt;</span> <span class='number'>0</span> <span class='op'>&amp;&amp;</span> <span class='ident'>s</span>[<span class='ident'>len</span><span class='op'>-</span><span class='number'>1</span>] <span class='op'>==</span> <span class='number'>0</span> { <span class='ident'>len</span> <span class='op'>-</span> <span class='number'>1</span> } <span class='kw'>else</span> { <span class='ident'>len</span> };
+ <span class='ident'>ANSI_STRING</span> { <span class='ident'>Length</span>: <span class='ident'>n</span> <span class='kw'>as</span> <span class='ident'>u16</span>, <span class='ident'>MaximumLength</span>: <span class='ident'>len</span> <span class='kw'>as</span> <span class='ident'>u16</span>, <span class='ident'>Buffer</span>: <span class='ident'>s</span>.<span class='ident'>as_ptr</span>() }
+ }
+}
+
+
+<span class='kw'>pub</span> <span class='kw'>type</span> <span class='ident'>AnsiString</span> <span class='op'>=</span> <span class='ident'>ANSI_STRING</span>;
+<span class='kw'>pub</span> <span class='kw'>type</span> <span class='ident'>UnicodeString</span> <span class='op'>=</span> <span class='ident'>UNICODE_STRING</span>;
+<span class='kw'>pub</span> <span class='kw'>type</span> <span class='ident'>CONST_UNICODE_STRING</span> <span class='op'>=</span> <span class='ident'>UNICODE_STRING</span>;
+<span class='kw'>pub</span> <span class='kw'>type</span> <span class='ident'>CONST_ANSI_STRING</span> <span class='op'>=</span> <span class='ident'>ANSI_STRING</span>;
+
+
+
+<span class='kw'>extern</span> <span class='string'>&quot;system&quot;</span>
+{
+ <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>RtlIntegerToUnicodeString</span>(<span class='ident'>Value</span>: <span class='ident'>u32</span>, <span class='ident'>Base</span>: <span class='ident'>u32</span>, <span class='ident'>String</span>: <span class='kw-2'>&amp;</span><span class='kw-2'>mut</span> <span class='ident'>UNICODE_STRING</span>) <span class='op'>-&gt;</span> <span class='ident'>NTSTATUS</span>;
+ <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>RtlInt64ToUnicodeString</span>(<span class='ident'>Value</span>: <span class='ident'>u64</span>, <span class='ident'>Base</span>: <span class='ident'>u32</span>, <span class='ident'>String</span>: <span class='kw-2'>&amp;</span><span class='kw-2'>mut</span> <span class='ident'>UNICODE_STRING</span>) <span class='op'>-&gt;</span> <span class='ident'>NTSTATUS</span>;
+ <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>RtlUnicodeStringToInteger</span>(<span class='ident'>String</span>: <span class='kw-2'>&amp;</span><span class='ident'>CONST_UNICODE_STRING</span>, <span class='ident'>Base</span>: <span class='ident'>u32</span>, <span class='ident'>Value</span>: <span class='kw-2'>&amp;</span><span class='kw-2'>mut</span> <span class='ident'>u32</span>) <span class='op'>-&gt;</span> <span class='ident'>NTSTATUS</span>;
+
+ <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>RtlUnicodeStringToAnsiString</span>(<span class='ident'>DestinationString</span>: <span class='kw-2'>&amp;</span><span class='kw-2'>mut</span> <span class='ident'>ANSI_STRING</span>, <span class='ident'>SourceString</span>: <span class='kw-2'>&amp;</span><span class='ident'>CONST_UNICODE_STRING</span>, <span class='ident'>AllocateDestination</span>: <span class='ident'>bool</span>) <span class='op'>-&gt;</span> <span class='ident'>NTSTATUS</span>;
+ <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>RtlUnicodeStringToAnsiSize</span>(<span class='ident'>SourceString</span>: <span class='kw-2'>&amp;</span><span class='ident'>CONST_UNICODE_STRING</span>) <span class='op'>-&gt;</span> <span class='ident'>u32</span>;
+
+ <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>RtlAnsiStringToUnicodeString</span>(<span class='ident'>DestinationString</span>: <span class='kw-2'>&amp;</span><span class='kw-2'>mut</span> <span class='ident'>UNICODE_STRING</span>, <span class='ident'>SourceString</span>: <span class='kw-2'>&amp;</span><span class='ident'>CONST_ANSI_STRING</span>, <span class='ident'>AllocateDestination</span>: <span class='ident'>bool</span>) <span class='op'>-&gt;</span> <span class='ident'>NTSTATUS</span>;
+ <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>RtlAnsiStringToUnicodeSize</span>(<span class='ident'>SourceString</span>: <span class='kw-2'>&amp;</span><span class='ident'>CONST_ANSI_STRING</span>) <span class='op'>-&gt;</span> <span class='ident'>u32</span>;
+
+ <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>RtlCompareUnicodeString</span> (<span class='ident'>String1</span>: <span class='kw-2'>&amp;</span><span class='ident'>CONST_UNICODE_STRING</span>, <span class='ident'>String2</span>: <span class='kw-2'>&amp;</span><span class='ident'>CONST_UNICODE_STRING</span>, <span class='ident'>CaseInSensitive</span>: <span class='ident'>bool</span>) <span class='op'>-&gt;</span> <span class='ident'>i32</span>;
+ <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>RtlCompareString</span> (<span class='ident'>String1</span>: <span class='kw-2'>&amp;</span><span class='ident'>CONST_ANSI_STRING</span>, <span class='ident'>String2</span>: <span class='kw-2'>&amp;</span><span class='ident'>CONST_ANSI_STRING</span>, <span class='ident'>CaseInSensitive</span>: <span class='ident'>bool</span>) <span class='op'>-&gt;</span> <span class='ident'>i32</span>;
+
+ <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>RtlEqualUnicodeString</span>(<span class='ident'>String1</span>: <span class='kw-2'>&amp;</span><span class='ident'>CONST_UNICODE_STRING</span>, <span class='ident'>String2</span>: <span class='kw-2'>&amp;</span><span class='ident'>CONST_UNICODE_STRING</span>) <span class='op'>-&gt;</span> <span class='ident'>bool</span>;
+ <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>RtlEqualString</span>(<span class='ident'>String1</span>: <span class='kw-2'>&amp;</span><span class='ident'>CONST_ANSI_STRING</span>, <span class='ident'>String2</span>: <span class='kw-2'>&amp;</span><span class='ident'>CONST_ANSI_STRING</span>) <span class='op'>-&gt;</span> <span class='ident'>bool</span>;
+
+ <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>RtlFreeAnsiString</span>(<span class='ident'>UnicodeString</span>: <span class='kw-2'>&amp;</span><span class='kw-2'>mut</span> <span class='ident'>ANSI_STRING</span>);
+ <span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>RtlFreeUnicodeString</span>(<span class='ident'>UnicodeString</span>: <span class='kw-2'>&amp;</span><span class='kw-2'>mut</span> <span class='ident'>UNICODE_STRING</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>
+ </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
generated by cgit v1.2.3 (git 2.25.1) at 2026-05-01 10:09:28 +0000