blob: 824c8f9fa0cc98e36efe81fe74122f8b965bd00b [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="API documentation for the Rust `Builder` struct in crate `rustyline`.">
<meta name="keywords" content="rust, rustlang, rust-lang, Builder">
<title>rustyline::config::Builder - Rust</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 struct">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<p class='location'>Struct Builder</p><div class="block items"><ul><li><a href="#methods">Methods</a></li><li><a href="#implementations">Trait Implementations</a></li></ul></div><p class='location'><a href='../index.html'>rustyline</a>::<wbr><a href='index.html'>config</a></p><script>window.sidebarCurrent = {name: 'Builder', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script>
</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">
<h1 class='fqn'><span class='in-band'>Struct <a href='../index.html'>rustyline</a>::<wbr><a href='index.html'>config</a>::<wbr><a class="struct" href=''>Builder</a></span><span class='out-of-band'><span id='render-detail'>
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
[<span class='inner'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../../src/rustyline/config.rs.html#96-98' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct Builder { /* fields omitted */ }</pre>
<h2 id='methods' class='small-section-header'>
Methods<a href='#methods' class='anchor'></a>
</h2>
<h3 class='impl'><span class='in-band'><code>impl <a class="struct" href="../../rustyline/config/struct.Builder.html" title="struct rustyline::config::Builder">Builder</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rustyline/config.rs.html#100-159' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>fn <a href='#method.new' class='fnname'>new</a>() -&gt; <a class="struct" href="../../rustyline/config/struct.Builder.html" title="struct rustyline::config::Builder">Builder</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rustyline/config.rs.html#101-103' title='goto source code'>[src]</a></span></h4>
<h4 id='method.max_history_size' class="method"><span id='max_history_size.v' class='invisible'><code>fn <a href='#method.max_history_size' class='fnname'>max_history_size</a>(self, max_size: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -&gt; <a class="struct" href="../../rustyline/config/struct.Builder.html" title="struct rustyline::config::Builder">Builder</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rustyline/config.rs.html#106-109' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Set the maximum length for the history.</p>
</div><h4 id='method.history_ignore_dups' class="method"><span id='history_ignore_dups.v' class='invisible'><code>fn <a href='#method.history_ignore_dups' class='fnname'>history_ignore_dups</a>(self, yes: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -&gt; <a class="struct" href="../../rustyline/config/struct.Builder.html" title="struct rustyline::config::Builder">Builder</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rustyline/config.rs.html#113-120' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Tell if lines which match the previous history entry are saved or not in the history list.
By default, they are ignored.</p>
</div><h4 id='method.history_ignore_space' class="method"><span id='history_ignore_space.v' class='invisible'><code>fn <a href='#method.history_ignore_space' class='fnname'>history_ignore_space</a>(self, yes: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -&gt; <a class="struct" href="../../rustyline/config/struct.Builder.html" title="struct rustyline::config::Builder">Builder</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rustyline/config.rs.html#124-127' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Tell if lines which begin with a space character are saved or not in the history list.
By default, they are saved.</p>
</div><h4 id='method.completion_type' class="method"><span id='completion_type.v' class='invisible'><code>fn <a href='#method.completion_type' class='fnname'>completion_type</a>(self, completion_type: <a class="enum" href="../../rustyline/config/enum.CompletionType.html" title="enum rustyline::config::CompletionType">CompletionType</a>) -&gt; <a class="struct" href="../../rustyline/config/struct.Builder.html" title="struct rustyline::config::Builder">Builder</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rustyline/config.rs.html#130-133' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Set <code>completion_type</code>.</p>
</div><h4 id='method.completion_prompt_limit' class="method"><span id='completion_prompt_limit.v' class='invisible'><code>fn <a href='#method.completion_prompt_limit' class='fnname'>completion_prompt_limit</a>(self, completion_prompt_limit: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -&gt; <a class="struct" href="../../rustyline/config/struct.Builder.html" title="struct rustyline::config::Builder">Builder</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rustyline/config.rs.html#137-140' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>The number of possible completions that determines when the user is asked
whether the list of possibilities should be displayed.</p>
</div><h4 id='method.keyseq_timeout' class="method"><span id='keyseq_timeout.v' class='invisible'><code>fn <a href='#method.keyseq_timeout' class='fnname'>keyseq_timeout</a>(self, keyseq_timeout_ms: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>) -&gt; <a class="struct" href="../../rustyline/config/struct.Builder.html" title="struct rustyline::config::Builder">Builder</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rustyline/config.rs.html#145-148' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Timeout for ambiguous key sequences in milliseconds.
Currently, it is used only to distinguish a single ESC from an ESC sequence.
After seeing an ESC key, wait at most <code>keyseq_timeout_ms</code> for another byte.</p>
</div><h4 id='method.edit_mode' class="method"><span id='edit_mode.v' class='invisible'><code>fn <a href='#method.edit_mode' class='fnname'>edit_mode</a>(self, edit_mode: <a class="enum" href="../../rustyline/config/enum.EditMode.html" title="enum rustyline::config::EditMode">EditMode</a>) -&gt; <a class="struct" href="../../rustyline/config/struct.Builder.html" title="struct rustyline::config::Builder">Builder</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rustyline/config.rs.html#151-154' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Choose between Emacs or Vi mode.</p>
</div><h4 id='method.build' class="method"><span id='build.v' class='invisible'><code>fn <a href='#method.build' class='fnname'>build</a>(self) -&gt; <a class="struct" href="../../rustyline/config/struct.Config.html" title="struct rustyline::config::Config">Config</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rustyline/config.rs.html#156-158' title='goto source code'>[src]</a></span></h4>
</div>
<h2 id='implementations' class='small-section-header'>
Trait Implementations<a href='#implementations' class='anchor'></a>
</h2>
<h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../rustyline/config/struct.Builder.html" title="struct rustyline::config::Builder">Builder</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rustyline/config.rs.html#95' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, __arg_0: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rustyline/config.rs.html#95' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Formats the value using the given formatter.</p>
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="../../rustyline/config/struct.Builder.html" title="struct rustyline::config::Builder">Builder</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rustyline/config.rs.html#95' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.default' class="method"><span id='default.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default' class='fnname'>default</a>() -&gt; <a class="struct" href="../../rustyline/config/struct.Builder.html" title="struct rustyline::config::Builder">Builder</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rustyline/config.rs.html#95' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns the &quot;default value&quot; for a type. <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default">Read more</a></p>
</div></div></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>