blob: 3d0b6e5b1a84d5825091ca09a6fe6c7746bbe37f [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 `src/consts.rs`.">
<meta name="keywords" content="rust, rustlang, rust-lang">
<title>consts.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>
</pre><pre class="rust ">
<span class="doccomment">//! Key constants</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Clone</span>, <span class="ident">Copy</span>, <span class="ident">PartialEq</span>, <span class="ident">Eq</span>, <span class="ident">Hash</span>)]</span>
<span class="kw">pub</span> <span class="kw">enum</span> <span class="ident">KeyPress</span> {
<span class="ident">UnknownEscSeq</span>,
<span class="ident">Backspace</span>,
<span class="ident">Char</span>(<span class="ident">char</span>),
<span class="ident">Ctrl</span>(<span class="ident">char</span>),
<span class="ident">Delete</span>,
<span class="ident">Down</span>,
<span class="ident">End</span>,
<span class="ident">Enter</span>, <span class="comment">// Ctrl(&#39;M&#39;)</span>
<span class="ident">Esc</span>,
<span class="ident">Home</span>,
<span class="ident">Left</span>,
<span class="ident">Meta</span>(<span class="ident">char</span>),
<span class="ident">Null</span>,
<span class="ident">PageDown</span>,
<span class="ident">PageUp</span>,
<span class="ident">Right</span>,
<span class="ident">Tab</span>, <span class="comment">// Ctrl(&#39;I&#39;)</span>
<span class="ident">Up</span>,
}
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">match_same_arms</span>)]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">char_to_key_press</span>(<span class="ident">c</span>: <span class="ident">char</span>) <span class="op">-&gt;</span> <span class="ident">KeyPress</span> {
<span class="kw">if</span> <span class="op">!</span><span class="ident">c</span>.<span class="ident">is_control</span>() {
<span class="kw">return</span> <span class="ident">KeyPress</span>::<span class="ident">Char</span>(<span class="ident">c</span>);
}
<span class="kw">match</span> <span class="ident">c</span> {
<span class="string">&#39;\x00&#39;</span> <span class="op">=&gt;</span> <span class="ident">KeyPress</span>::<span class="ident">Null</span>,
<span class="string">&#39;\x01&#39;</span> <span class="op">=&gt;</span> <span class="ident">KeyPress</span>::<span class="ident">Ctrl</span>(<span class="string">&#39;A&#39;</span>),
<span class="string">&#39;\x02&#39;</span> <span class="op">=&gt;</span> <span class="ident">KeyPress</span>::<span class="ident">Ctrl</span>(<span class="string">&#39;B&#39;</span>),
<span class="string">&#39;\x03&#39;</span> <span class="op">=&gt;</span> <span class="ident">KeyPress</span>::<span class="ident">Ctrl</span>(<span class="string">&#39;C&#39;</span>),
<span class="string">&#39;\x04&#39;</span> <span class="op">=&gt;</span> <span class="ident">KeyPress</span>::<span class="ident">Ctrl</span>(<span class="string">&#39;D&#39;</span>),
<span class="string">&#39;\x05&#39;</span> <span class="op">=&gt;</span> <span class="ident">KeyPress</span>::<span class="ident">Ctrl</span>(<span class="string">&#39;E&#39;</span>),
<span class="string">&#39;\x06&#39;</span> <span class="op">=&gt;</span> <span class="ident">KeyPress</span>::<span class="ident">Ctrl</span>(<span class="string">&#39;F&#39;</span>),
<span class="string">&#39;\x07&#39;</span> <span class="op">=&gt;</span> <span class="ident">KeyPress</span>::<span class="ident">Ctrl</span>(<span class="string">&#39;G&#39;</span>),
<span class="string">&#39;\x08&#39;</span> <span class="op">=&gt;</span> <span class="ident">KeyPress</span>::<span class="ident">Backspace</span>, <span class="comment">// &#39;\b&#39;</span>
<span class="string">&#39;\x09&#39;</span> <span class="op">=&gt;</span> <span class="ident">KeyPress</span>::<span class="ident">Tab</span>,
<span class="string">&#39;\x0a&#39;</span> <span class="op">=&gt;</span> <span class="ident">KeyPress</span>::<span class="ident">Ctrl</span>(<span class="string">&#39;J&#39;</span>), <span class="comment">// &#39;\n&#39; (10)</span>
<span class="string">&#39;\x0b&#39;</span> <span class="op">=&gt;</span> <span class="ident">KeyPress</span>::<span class="ident">Ctrl</span>(<span class="string">&#39;K&#39;</span>),
<span class="string">&#39;\x0c&#39;</span> <span class="op">=&gt;</span> <span class="ident">KeyPress</span>::<span class="ident">Ctrl</span>(<span class="string">&#39;L&#39;</span>),
<span class="string">&#39;\x0d&#39;</span> <span class="op">=&gt;</span> <span class="ident">KeyPress</span>::<span class="ident">Enter</span>, <span class="comment">// &#39;\r&#39; (13)</span>
<span class="string">&#39;\x0e&#39;</span> <span class="op">=&gt;</span> <span class="ident">KeyPress</span>::<span class="ident">Ctrl</span>(<span class="string">&#39;N&#39;</span>),
<span class="string">&#39;\x10&#39;</span> <span class="op">=&gt;</span> <span class="ident">KeyPress</span>::<span class="ident">Ctrl</span>(<span class="string">&#39;P&#39;</span>),
<span class="string">&#39;\x12&#39;</span> <span class="op">=&gt;</span> <span class="ident">KeyPress</span>::<span class="ident">Ctrl</span>(<span class="string">&#39;R&#39;</span>),
<span class="string">&#39;\x13&#39;</span> <span class="op">=&gt;</span> <span class="ident">KeyPress</span>::<span class="ident">Ctrl</span>(<span class="string">&#39;S&#39;</span>),
<span class="string">&#39;\x14&#39;</span> <span class="op">=&gt;</span> <span class="ident">KeyPress</span>::<span class="ident">Ctrl</span>(<span class="string">&#39;T&#39;</span>),
<span class="string">&#39;\x15&#39;</span> <span class="op">=&gt;</span> <span class="ident">KeyPress</span>::<span class="ident">Ctrl</span>(<span class="string">&#39;U&#39;</span>),
<span class="string">&#39;\x16&#39;</span> <span class="op">=&gt;</span> <span class="ident">KeyPress</span>::<span class="ident">Ctrl</span>(<span class="string">&#39;V&#39;</span>),
<span class="string">&#39;\x17&#39;</span> <span class="op">=&gt;</span> <span class="ident">KeyPress</span>::<span class="ident">Ctrl</span>(<span class="string">&#39;W&#39;</span>),
<span class="string">&#39;\x19&#39;</span> <span class="op">=&gt;</span> <span class="ident">KeyPress</span>::<span class="ident">Ctrl</span>(<span class="string">&#39;Y&#39;</span>),
<span class="string">&#39;\x1a&#39;</span> <span class="op">=&gt;</span> <span class="ident">KeyPress</span>::<span class="ident">Ctrl</span>(<span class="string">&#39;Z&#39;</span>),
<span class="string">&#39;\x1b&#39;</span> <span class="op">=&gt;</span> <span class="ident">KeyPress</span>::<span class="ident">Esc</span>,
<span class="string">&#39;\x7f&#39;</span> <span class="op">=&gt;</span> <span class="ident">KeyPress</span>::<span class="ident">Backspace</span>,
_ <span class="op">=&gt;</span> <span class="ident">KeyPress</span>::<span class="ident">Null</span>,
}
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
<span class="kw">mod</span> <span class="ident">tests</span> {
<span class="kw">use</span> <span class="kw">super</span>::{<span class="ident">char_to_key_press</span>, <span class="ident">KeyPress</span>};
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">char_to_key</span>() {
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">KeyPress</span>::<span class="ident">Esc</span>, <span class="ident">char_to_key_press</span>(<span class="string">&#39;\x1b&#39;</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 = "rustyline";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>