blob: 2f97ee8435c28d2aa6d55845842c34fdc5754c98 [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/mqueue.rs`.">
<meta name="keywords" content="rust, rustlang, rust-lang">
<title>mqueue.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>
<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>
<span id="96"> 96</span>
<span id="97"> 97</span>
<span id="98"> 98</span>
<span id="99"> 99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
</pre><pre class="rust ">
<span class="doccomment">//! Posix Message Queue functions</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! [Further reading and details on the C API](http://man7.org/linux/man-pages/man7/mq_overview.7.html)</span>
<span class="kw">use</span> {<span class="ident">Errno</span>, <span class="prelude-ty">Result</span>};
<span class="kw">use</span> <span class="ident">libc</span>::{<span class="self">self</span>, <span class="ident">c_char</span>, <span class="ident">c_long</span>, <span class="ident">mode_t</span>, <span class="ident">mqd_t</span>, <span class="ident">size_t</span>};
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">ffi</span>::<span class="ident">CString</span>;
<span class="kw">use</span> <span class="ident">sys</span>::<span class="ident">stat</span>::<span class="ident">Mode</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">mem</span>;
<span class="macro">libc_bitflags</span><span class="macro">!</span>{
<span class="kw">pub</span> <span class="ident">flags</span> <span class="ident">MQ_OFlag</span>: <span class="ident">libc</span>::<span class="ident">c_int</span> {
<span class="ident">O_RDONLY</span>,
<span class="ident">O_WRONLY</span>,
<span class="ident">O_RDWR</span>,
<span class="ident">O_CREAT</span>,
<span class="ident">O_EXCL</span>,
<span class="ident">O_NONBLOCK</span>,
<span class="ident">O_CLOEXEC</span>,
}
}
<span class="macro">libc_bitflags</span><span class="macro">!</span>{
<span class="kw">pub</span> <span class="ident">flags</span> <span class="ident">FdFlag</span>: <span class="ident">libc</span>::<span class="ident">c_int</span> {
<span class="ident">FD_CLOEXEC</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">struct</span> <span class="ident">MqAttr</span> {
<span class="ident">mq_attr</span>: <span class="ident">libc</span>::<span class="ident">mq_attr</span>,
}
<span class="kw">impl</span> <span class="ident">PartialEq</span><span class="op">&lt;</span><span class="ident">MqAttr</span><span class="op">&gt;</span> <span class="kw">for</span> <span class="ident">MqAttr</span> {
<span class="kw">fn</span> <span class="ident">eq</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">other</span>: <span class="kw-2">&amp;</span><span class="ident">MqAttr</span>) <span class="op">-&gt;</span> <span class="ident">bool</span> {
<span class="kw">let</span> <span class="ident">self_attr</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">mq_attr</span>;
<span class="kw">let</span> <span class="ident">other_attr</span> <span class="op">=</span> <span class="ident">other</span>.<span class="ident">mq_attr</span>;
<span class="ident">self_attr</span>.<span class="ident">mq_flags</span> <span class="op">==</span> <span class="ident">other_attr</span>.<span class="ident">mq_flags</span> <span class="op">&amp;&amp;</span> <span class="ident">self_attr</span>.<span class="ident">mq_maxmsg</span> <span class="op">==</span> <span class="ident">other_attr</span>.<span class="ident">mq_maxmsg</span> <span class="op">&amp;&amp;</span>
<span class="ident">self_attr</span>.<span class="ident">mq_msgsize</span> <span class="op">==</span> <span class="ident">other_attr</span>.<span class="ident">mq_msgsize</span> <span class="op">&amp;&amp;</span>
<span class="ident">self_attr</span>.<span class="ident">mq_curmsgs</span> <span class="op">==</span> <span class="ident">other_attr</span>.<span class="ident">mq_curmsgs</span>
}
}
<span class="kw">impl</span> <span class="ident">MqAttr</span> {
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">mq_flags</span>: <span class="ident">c_long</span>,
<span class="ident">mq_maxmsg</span>: <span class="ident">c_long</span>,
<span class="ident">mq_msgsize</span>: <span class="ident">c_long</span>,
<span class="ident">mq_curmsgs</span>: <span class="ident">c_long</span>)
<span class="op">-&gt;</span> <span class="ident">MqAttr</span> {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">attr</span> <span class="op">=</span> <span class="kw">unsafe</span> { <span class="ident">mem</span>::<span class="ident">uninitialized</span>::<span class="op">&lt;</span><span class="ident">libc</span>::<span class="ident">mq_attr</span><span class="op">&gt;</span>() };
<span class="ident">attr</span>.<span class="ident">mq_flags</span> <span class="op">=</span> <span class="ident">mq_flags</span>;
<span class="ident">attr</span>.<span class="ident">mq_maxmsg</span> <span class="op">=</span> <span class="ident">mq_maxmsg</span>;
<span class="ident">attr</span>.<span class="ident">mq_msgsize</span> <span class="op">=</span> <span class="ident">mq_msgsize</span>;
<span class="ident">attr</span>.<span class="ident">mq_curmsgs</span> <span class="op">=</span> <span class="ident">mq_curmsgs</span>;
<span class="ident">MqAttr</span> { <span class="ident">mq_attr</span>: <span class="ident">attr</span> }
}
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">flags</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">c_long</span> {
<span class="self">self</span>.<span class="ident">mq_attr</span>.<span class="ident">mq_flags</span>
}
}
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">mq_open</span>(<span class="ident">name</span>: <span class="kw-2">&amp;</span><span class="ident">CString</span>,
<span class="ident">oflag</span>: <span class="ident">MQ_OFlag</span>,
<span class="ident">mode</span>: <span class="ident">Mode</span>,
<span class="ident">attr</span>: <span class="prelude-ty">Option</span><span class="op">&lt;</span><span class="kw-2">&amp;</span><span class="ident">MqAttr</span><span class="op">&gt;</span>)
<span class="op">-&gt;</span> <span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="ident">mqd_t</span><span class="op">&gt;</span> {
<span class="kw">let</span> <span class="ident">res</span> <span class="op">=</span> <span class="kw">match</span> <span class="ident">attr</span> {
<span class="prelude-val">Some</span>(<span class="ident">mq_attr</span>) <span class="op">=&gt;</span> <span class="kw">unsafe</span> {
<span class="ident">libc</span>::<span class="ident">mq_open</span>(<span class="ident">name</span>.<span class="ident">as_ptr</span>(),
<span class="ident">oflag</span>.<span class="ident">bits</span>(),
<span class="ident">mode</span>.<span class="ident">bits</span>() <span class="kw">as</span> <span class="ident">mode_t</span>,
<span class="kw-2">&amp;</span><span class="ident">mq_attr</span>.<span class="ident">mq_attr</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw">const</span> <span class="ident">libc</span>::<span class="ident">mq_attr</span>)
},
<span class="prelude-val">None</span> <span class="op">=&gt;</span> <span class="kw">unsafe</span> { <span class="ident">libc</span>::<span class="ident">mq_open</span>(<span class="ident">name</span>.<span class="ident">as_ptr</span>(), <span class="ident">oflag</span>.<span class="ident">bits</span>()) },
};
<span class="ident">Errno</span>::<span class="ident">result</span>(<span class="ident">res</span>)
}
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">mq_unlink</span>(<span class="ident">name</span>: <span class="kw-2">&amp;</span><span class="ident">CString</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">res</span> <span class="op">=</span> <span class="kw">unsafe</span> { <span class="ident">libc</span>::<span class="ident">mq_unlink</span>(<span class="ident">name</span>.<span class="ident">as_ptr</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>)
}
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">mq_close</span>(<span class="ident">mqdes</span>: <span class="ident">mqd_t</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">res</span> <span class="op">=</span> <span class="kw">unsafe</span> { <span class="ident">libc</span>::<span class="ident">mq_close</span>(<span class="ident">mqdes</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>)
}
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">mq_receive</span>(<span class="ident">mqdes</span>: <span class="ident">mqd_t</span>, <span class="ident">message</span>: <span class="kw-2">&amp;</span><span class="kw-2">mut</span> [<span class="ident">u8</span>], <span class="ident">msg_prio</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="prelude-ty">Result</span><span class="op">&lt;</span><span class="ident">usize</span><span class="op">&gt;</span> {
<span class="kw">let</span> <span class="ident">len</span> <span class="op">=</span> <span class="ident">message</span>.<span class="ident">len</span>() <span class="kw">as</span> <span class="ident">size_t</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">mq_receive</span>(<span class="ident">mqdes</span>,
<span class="ident">message</span>.<span class="ident">as_mut_ptr</span>() <span class="kw">as</span> <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">c_char</span>,
<span class="ident">len</span>,
<span class="ident">msg_prio</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">u32</span>)
};
<span class="ident">Errno</span>::<span class="ident">result</span>(<span class="ident">res</span>).<span class="ident">map</span>(<span class="op">|</span><span class="ident">r</span><span class="op">|</span> <span class="ident">r</span> <span class="kw">as</span> <span class="ident">usize</span>)
}
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">mq_send</span>(<span class="ident">mqdes</span>: <span class="ident">mqd_t</span>, <span class="ident">message</span>: <span class="kw-2">&amp;</span>[<span class="ident">u8</span>], <span class="ident">msq_prio</span>: <span class="ident">u32</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">res</span> <span class="op">=</span> <span class="kw">unsafe</span> {
<span class="ident">libc</span>::<span class="ident">mq_send</span>(<span class="ident">mqdes</span>,
<span class="ident">message</span>.<span class="ident">as_ptr</span>() <span class="kw">as</span> <span class="kw-2">*</span><span class="kw">const</span> <span class="ident">c_char</span>,
<span class="ident">message</span>.<span class="ident">len</span>(),
<span class="ident">msq_prio</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>)
}
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">mq_getattr</span>(<span class="ident">mqd</span>: <span class="ident">mqd_t</span>) <span class="op">-&gt;</span> <span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="ident">MqAttr</span><span class="op">&gt;</span> {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">attr</span> <span class="op">=</span> <span class="kw">unsafe</span> { <span class="ident">mem</span>::<span class="ident">uninitialized</span>::<span class="op">&lt;</span><span class="ident">libc</span>::<span class="ident">mq_attr</span><span class="op">&gt;</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">mq_getattr</span>(<span class="ident">mqd</span>, <span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">attr</span>) };
<span class="ident">Errno</span>::<span class="ident">result</span>(<span class="ident">res</span>).<span class="ident">map</span>(<span class="op">|</span>_<span class="op">|</span> <span class="ident">MqAttr</span> { <span class="ident">mq_attr</span>: <span class="ident">attr</span> })
}
<span class="doccomment">/// Set the attributes of the message queue. Only `O_NONBLOCK` can be set, everything else will be ignored</span>
<span class="doccomment">/// Returns the old attributes</span>
<span class="doccomment">/// It is recommend to use the `mq_set_nonblock()` and `mq_remove_nonblock()` convenience functions as they are easier to use</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [Further reading](http://man7.org/linux/man-pages/man3/mq_setattr.3.html)</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">mq_setattr</span>(<span class="ident">mqd</span>: <span class="ident">mqd_t</span>, <span class="ident">newattr</span>: <span class="kw-2">&amp;</span><span class="ident">MqAttr</span>) <span class="op">-&gt;</span> <span class="prelude-ty">Result</span><span class="op">&lt;</span><span class="ident">MqAttr</span><span class="op">&gt;</span> {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">attr</span> <span class="op">=</span> <span class="kw">unsafe</span> { <span class="ident">mem</span>::<span class="ident">uninitialized</span>::<span class="op">&lt;</span><span class="ident">libc</span>::<span class="ident">mq_attr</span><span class="op">&gt;</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">mq_setattr</span>(<span class="ident">mqd</span>, <span class="kw-2">&amp;</span><span class="ident">newattr</span>.<span class="ident">mq_attr</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw">const</span> <span class="ident">libc</span>::<span class="ident">mq_attr</span>, <span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">attr</span>) };
<span class="ident">Errno</span>::<span class="ident">result</span>(<span class="ident">res</span>).<span class="ident">map</span>(<span class="op">|</span>_<span class="op">|</span> <span class="ident">MqAttr</span> { <span class="ident">mq_attr</span>: <span class="ident">attr</span> })
}
<span class="doccomment">/// Convenience function.</span>
<span class="doccomment">/// Sets the `O_NONBLOCK` attribute for a given message queue descriptor</span>
<span class="doccomment">/// Returns the old attributes</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">mq_set_nonblock</span>(<span class="ident">mqd</span>: <span class="ident">mqd_t</span>) <span class="op">-&gt;</span> <span class="prelude-ty">Result</span><span class="op">&lt;</span>(<span class="ident">MqAttr</span>)<span class="op">&gt;</span> {
<span class="kw">let</span> <span class="ident">oldattr</span> <span class="op">=</span> <span class="macro">try</span><span class="macro">!</span>(<span class="ident">mq_getattr</span>(<span class="ident">mqd</span>));
<span class="kw">let</span> <span class="ident">newattr</span> <span class="op">=</span> <span class="ident">MqAttr</span>::<span class="ident">new</span>(<span class="ident">O_NONBLOCK</span>.<span class="ident">bits</span>() <span class="kw">as</span> <span class="ident">c_long</span>,
<span class="ident">oldattr</span>.<span class="ident">mq_attr</span>.<span class="ident">mq_maxmsg</span>,
<span class="ident">oldattr</span>.<span class="ident">mq_attr</span>.<span class="ident">mq_msgsize</span>,
<span class="ident">oldattr</span>.<span class="ident">mq_attr</span>.<span class="ident">mq_curmsgs</span>);
<span class="ident">mq_setattr</span>(<span class="ident">mqd</span>, <span class="kw-2">&amp;</span><span class="ident">newattr</span>)
}
<span class="doccomment">/// Convenience function.</span>
<span class="doccomment">/// Removes `O_NONBLOCK` attribute for a given message queue descriptor</span>
<span class="doccomment">/// Returns the old attributes</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">mq_remove_nonblock</span>(<span class="ident">mqd</span>: <span class="ident">mqd_t</span>) <span class="op">-&gt;</span> <span class="prelude-ty">Result</span><span class="op">&lt;</span>(<span class="ident">MqAttr</span>)<span class="op">&gt;</span> {
<span class="kw">let</span> <span class="ident">oldattr</span> <span class="op">=</span> <span class="macro">try</span><span class="macro">!</span>(<span class="ident">mq_getattr</span>(<span class="ident">mqd</span>));
<span class="kw">let</span> <span class="ident">newattr</span> <span class="op">=</span> <span class="ident">MqAttr</span>::<span class="ident">new</span>(<span class="number">0</span>,
<span class="ident">oldattr</span>.<span class="ident">mq_attr</span>.<span class="ident">mq_maxmsg</span>,
<span class="ident">oldattr</span>.<span class="ident">mq_attr</span>.<span class="ident">mq_msgsize</span>,
<span class="ident">oldattr</span>.<span class="ident">mq_attr</span>.<span class="ident">mq_curmsgs</span>);
<span class="ident">mq_setattr</span>(<span class="ident">mqd</span>, <span class="kw-2">&amp;</span><span class="ident">newattr</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>