| <!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/config.rs`."> |
| <meta name="keywords" content="rust, rustlang, rust-lang"> |
| |
| <title>config.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> |
| <span id="154">154</span> |
| <span id="155">155</span> |
| <span id="156">156</span> |
| <span id="157">157</span> |
| <span id="158">158</span> |
| <span id="159">159</span> |
| </pre><pre class="rust "> |
| <span class="doccomment">//! Customize line editor</span> |
| <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">default</span>::<span class="ident">Default</span>; |
| |
| <span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">Copy</span>, <span class="ident">Debug</span>, <span class="ident">PartialEq</span>, <span class="ident">Eq</span>)]</span> |
| <span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Config</span> { |
| <span class="doccomment">/// Maximum number of entries in History.</span> |
| <span class="ident">max_history_size</span>: <span class="ident">usize</span>, |
| <span class="ident">history_duplicates</span>: <span class="ident">HistoryDuplicates</span>, |
| <span class="ident">history_ignore_space</span>: <span class="ident">bool</span>, |
| <span class="ident">completion_type</span>: <span class="ident">CompletionType</span>, |
| <span class="doccomment">/// When listing completion alternatives, only display</span> |
| <span class="doccomment">/// one screen of possibilities at a time.</span> |
| <span class="ident">completion_prompt_limit</span>: <span class="ident">usize</span>, |
| <span class="doccomment">/// Duration (milliseconds) Rustyline will wait for a character when reading an ambiguous key sequence.</span> |
| <span class="ident">keyseq_timeout</span>: <span class="ident">i32</span>, |
| <span class="comment">// Emacs or Vi mode</span> |
| <span class="ident">edit_mode</span>: <span class="ident">EditMode</span>, |
| } |
| |
| <span class="kw">impl</span> <span class="ident">Config</span> { |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">builder</span>() <span class="op">-></span> <span class="ident">Builder</span> { |
| <span class="ident">Builder</span>::<span class="ident">new</span>() |
| } |
| |
| <span class="doccomment">/// Tell the maximum length (i.e. number of entries) for the history.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">max_history_size</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">usize</span> { |
| <span class="self">self</span>.<span class="ident">max_history_size</span> |
| } |
| |
| <span class="doccomment">/// Tell if lines which match the previous history entry are saved or not in the history list.</span> |
| <span class="doccomment">/// By default, they are ignored.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">history_duplicates</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">HistoryDuplicates</span> { |
| <span class="self">self</span>.<span class="ident">history_duplicates</span> |
| } |
| |
| <span class="doccomment">/// Tell if lines which begin with a space character are saved or not in the history list.</span> |
| <span class="doccomment">/// By default, they are saved.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">history_ignore_space</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">bool</span> { |
| <span class="self">self</span>.<span class="ident">history_ignore_space</span> |
| } |
| |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">completion_type</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">CompletionType</span> { |
| <span class="self">self</span>.<span class="ident">completion_type</span> |
| } |
| |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">completion_prompt_limit</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">usize</span> { |
| <span class="self">self</span>.<span class="ident">completion_prompt_limit</span> |
| } |
| |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">keyseq_timeout</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">i32</span> { |
| <span class="self">self</span>.<span class="ident">keyseq_timeout</span> |
| } |
| |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">edit_mode</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">EditMode</span> { |
| <span class="self">self</span>.<span class="ident">edit_mode</span> |
| } |
| } |
| |
| <span class="kw">impl</span> <span class="ident">Default</span> <span class="kw">for</span> <span class="ident">Config</span> { |
| <span class="kw">fn</span> <span class="ident">default</span>() <span class="op">-></span> <span class="ident">Config</span> { |
| <span class="ident">Config</span> { |
| <span class="ident">max_history_size</span>: <span class="number">100</span>, |
| <span class="ident">history_duplicates</span>: <span class="ident">HistoryDuplicates</span>::<span class="ident">IgnoreConsecutive</span>, |
| <span class="ident">history_ignore_space</span>: <span class="bool-val">false</span>, |
| <span class="ident">completion_type</span>: <span class="ident">CompletionType</span>::<span class="ident">Circular</span>, <span class="comment">// TODO Validate</span> |
| <span class="ident">completion_prompt_limit</span>: <span class="number">100</span>, |
| <span class="ident">keyseq_timeout</span>: <span class="number">500</span>, |
| <span class="ident">edit_mode</span>: <span class="ident">EditMode</span>::<span class="ident">Emacs</span>, |
| } |
| } |
| } |
| |
| <span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">Copy</span>, <span class="ident">Debug</span>, <span class="ident">PartialEq</span>, <span class="ident">Eq</span>)]</span> |
| <span class="kw">pub</span> <span class="kw">enum</span> <span class="ident">HistoryDuplicates</span> { |
| <span class="ident">AlwaysAdd</span>, |
| <span class="ident">IgnoreConsecutive</span>, |
| } |
| |
| <span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">Copy</span>, <span class="ident">Debug</span>, <span class="ident">PartialEq</span>, <span class="ident">Eq</span>)]</span> |
| <span class="kw">pub</span> <span class="kw">enum</span> <span class="ident">CompletionType</span> { |
| <span class="doccomment">/// Complete the next full match (like in Vim by default)</span> |
| <span class="ident">Circular</span>, |
| <span class="doccomment">/// Complete till longest match.</span> |
| <span class="doccomment">/// When more than one match, list all matches</span> |
| <span class="doccomment">/// (like in Bash/Readline).</span> |
| <span class="ident">List</span>, |
| } |
| |
| <span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">Copy</span>, <span class="ident">Debug</span>, <span class="ident">PartialEq</span>, <span class="ident">Eq</span>)]</span> |
| <span class="kw">pub</span> <span class="kw">enum</span> <span class="ident">EditMode</span> { |
| <span class="ident">Emacs</span>, |
| <span class="ident">Vi</span>, |
| } |
| |
| <span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Default</span>)]</span> |
| <span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Builder</span> { |
| <span class="ident">p</span>: <span class="ident">Config</span>, |
| } |
| |
| <span class="kw">impl</span> <span class="ident">Builder</span> { |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>() <span class="op">-></span> <span class="ident">Builder</span> { |
| <span class="ident">Builder</span> { <span class="ident">p</span>: <span class="ident">Config</span>::<span class="ident">default</span>() } |
| } |
| |
| <span class="doccomment">/// Set the maximum length for the history.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">max_history_size</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">max_size</span>: <span class="ident">usize</span>) <span class="op">-></span> <span class="ident">Builder</span> { |
| <span class="self">self</span>.<span class="ident">p</span>.<span class="ident">max_history_size</span> <span class="op">=</span> <span class="ident">max_size</span>; |
| <span class="self">self</span> |
| } |
| |
| <span class="doccomment">/// Tell if lines which match the previous history entry are saved or not in the history list.</span> |
| <span class="doccomment">/// By default, they are ignored.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">history_ignore_dups</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">yes</span>: <span class="ident">bool</span>) <span class="op">-></span> <span class="ident">Builder</span> { |
| <span class="self">self</span>.<span class="ident">p</span>.<span class="ident">history_duplicates</span> <span class="op">=</span> <span class="kw">if</span> <span class="ident">yes</span> { |
| <span class="ident">HistoryDuplicates</span>::<span class="ident">IgnoreConsecutive</span> |
| } <span class="kw">else</span> { |
| <span class="ident">HistoryDuplicates</span>::<span class="ident">AlwaysAdd</span> |
| }; |
| <span class="self">self</span> |
| } |
| |
| <span class="doccomment">/// Tell if lines which begin with a space character are saved or not in the history list.</span> |
| <span class="doccomment">/// By default, they are saved.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">history_ignore_space</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">yes</span>: <span class="ident">bool</span>) <span class="op">-></span> <span class="ident">Builder</span> { |
| <span class="self">self</span>.<span class="ident">p</span>.<span class="ident">history_ignore_space</span> <span class="op">=</span> <span class="ident">yes</span>; |
| <span class="self">self</span> |
| } |
| |
| <span class="doccomment">/// Set `completion_type`.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">completion_type</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">completion_type</span>: <span class="ident">CompletionType</span>) <span class="op">-></span> <span class="ident">Builder</span> { |
| <span class="self">self</span>.<span class="ident">p</span>.<span class="ident">completion_type</span> <span class="op">=</span> <span class="ident">completion_type</span>; |
| <span class="self">self</span> |
| } |
| |
| <span class="doccomment">/// The number of possible completions that determines when the user is asked</span> |
| <span class="doccomment">/// whether the list of possibilities should be displayed.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">completion_prompt_limit</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">completion_prompt_limit</span>: <span class="ident">usize</span>) <span class="op">-></span> <span class="ident">Builder</span> { |
| <span class="self">self</span>.<span class="ident">p</span>.<span class="ident">completion_prompt_limit</span> <span class="op">=</span> <span class="ident">completion_prompt_limit</span>; |
| <span class="self">self</span> |
| } |
| |
| <span class="doccomment">/// Timeout for ambiguous key sequences in milliseconds.</span> |
| <span class="doccomment">/// Currently, it is used only to distinguish a single ESC from an ESC sequence.</span> |
| <span class="doccomment">/// After seeing an ESC key, wait at most `keyseq_timeout_ms` for another byte.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">keyseq_timeout</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">keyseq_timeout_ms</span>: <span class="ident">i32</span>) <span class="op">-></span> <span class="ident">Builder</span> { |
| <span class="self">self</span>.<span class="ident">p</span>.<span class="ident">keyseq_timeout</span> <span class="op">=</span> <span class="ident">keyseq_timeout_ms</span>; |
| <span class="self">self</span> |
| } |
| |
| <span class="doccomment">/// Choose between Emacs or Vi mode.</span> |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">edit_mode</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">edit_mode</span>: <span class="ident">EditMode</span>) <span class="op">-></span> <span class="ident">Builder</span> { |
| <span class="self">self</span>.<span class="ident">p</span>.<span class="ident">edit_mode</span> <span class="op">=</span> <span class="ident">edit_mode</span>; |
| <span class="self">self</span> |
| } |
| |
| <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">build</span>(<span class="self">self</span>) <span class="op">-></span> <span class="ident">Config</span> { |
| <span class="self">self</span>.<span class="ident">p</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> |