| <!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/tty/mod.rs`."> |
| <meta name="keywords" content="rust, rustlang, rust-lang"> |
| |
| <title>mod.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> |
| </pre><pre class="rust "> |
| <span class="doccomment">//! This module implements and describes common TTY methods & traits</span> |
| <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">Write</span>; |
| <span class="kw">use</span> <span class="prelude-ty">Result</span>; |
| <span class="kw">use</span> <span class="ident">config</span>::<span class="ident">Config</span>; |
| <span class="kw">use</span> <span class="ident">consts</span>::<span class="ident">KeyPress</span>; |
| |
| <span class="doccomment">/// Terminal state</span> |
| <span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">RawMode</span>: <span class="ident">Copy</span> <span class="op">+</span> <span class="ident">Sized</span> { |
| <span class="doccomment">/// Disable RAW mode for the terminal.</span> |
| <span class="kw">fn</span> <span class="ident">disable_raw_mode</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span>; |
| } |
| |
| <span class="doccomment">/// Translate bytes read from stdin to keys.</span> |
| <span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">RawReader</span>: <span class="ident">Sized</span> { |
| <span class="doccomment">/// Blocking read of key pressed.</span> |
| <span class="kw">fn</span> <span class="ident">next_key</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">KeyPress</span><span class="op">></span>; |
| <span class="doccomment">/// For CTRL-V support</span> |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">unix</span>)]</span> |
| <span class="kw">fn</span> <span class="ident">next_char</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">char</span><span class="op">></span>; |
| } |
| |
| <span class="doccomment">/// Terminal contract</span> |
| <span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">Term</span>: <span class="ident">Clone</span> { |
| <span class="kw">type</span> <span class="ident">Reader</span>: <span class="ident">RawReader</span>; |
| <span class="kw">type</span> <span class="ident">Writer</span>: <span class="ident">Write</span>; |
| <span class="kw">type</span> <span class="ident">Mode</span>: <span class="ident">RawMode</span>; |
| |
| <span class="kw">fn</span> <span class="ident">new</span>() <span class="op">-></span> <span class="self">Self</span>; |
| <span class="doccomment">/// Check if current terminal can provide a rich line-editing user interface.</span> |
| <span class="kw">fn</span> <span class="ident">is_unsupported</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">bool</span>; |
| <span class="doccomment">/// check if stdin is connected to a terminal.</span> |
| <span class="kw">fn</span> <span class="ident">is_stdin_tty</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">bool</span>; |
| <span class="doccomment">/// Get the number of columns in the current terminal.</span> |
| <span class="kw">fn</span> <span class="ident">get_columns</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">usize</span>; |
| <span class="doccomment">/// Get the number of rows in the current terminal.</span> |
| <span class="kw">fn</span> <span class="ident">get_rows</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">usize</span>; |
| <span class="doccomment">/// Check if a SIGWINCH signal has been received</span> |
| <span class="kw">fn</span> <span class="ident">sigwinch</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">bool</span>; |
| <span class="doccomment">/// Enable RAW mode for the terminal.</span> |
| <span class="kw">fn</span> <span class="ident">enable_raw_mode</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="self">Self</span>::<span class="ident">Mode</span><span class="op">></span>; |
| <span class="doccomment">/// Create a RAW reader</span> |
| <span class="kw">fn</span> <span class="ident">create_reader</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">config</span>: <span class="kw-2">&</span><span class="ident">Config</span>) <span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="self">Self</span>::<span class="ident">Reader</span><span class="op">></span>; |
| <span class="doccomment">/// Create a writer</span> |
| <span class="kw">fn</span> <span class="ident">create_writer</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="self">Self</span>::<span class="ident">Writer</span>; |
| <span class="doccomment">/// Clear the screen. Used to handle ctrl+l</span> |
| <span class="kw">fn</span> <span class="ident">clear_screen</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">w</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">Write</span>) <span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span>; |
| } |
| |
| <span class="comment">// If on Windows platform import Windows TTY module</span> |
| <span class="comment">// and re-export into mod.rs scope</span> |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">all</span>(<span class="ident">windows</span>, <span class="ident">not</span>(<span class="ident">test</span>)))]</span> |
| <span class="kw">mod</span> <span class="ident">windows</span>; |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">all</span>(<span class="ident">windows</span>, <span class="ident">not</span>(<span class="ident">test</span>)))]</span> |
| <span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">windows</span>::<span class="kw-2">*</span>; |
| |
| <span class="comment">// If on Unix platform import Unix TTY module</span> |
| <span class="comment">// and re-export into mod.rs scope</span> |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">all</span>(<span class="ident">unix</span>, <span class="ident">not</span>(<span class="ident">test</span>)))]</span> |
| <span class="kw">mod</span> <span class="ident">unix</span>; |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">all</span>(<span class="ident">unix</span>, <span class="ident">not</span>(<span class="ident">test</span>)))]</span> |
| <span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">unix</span>::<span class="kw-2">*</span>; |
| |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span> |
| <span class="kw">mod</span> <span class="ident">test</span>; |
| <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span> |
| <span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">test</span>::<span class="kw-2">*</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> |
| <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> |
