| <!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 `Config` struct in crate `rustyline`."> |
| <meta name="keywords" content="rust, rustlang, rust-lang, Config"> |
| |
| <title>rustyline::config::Config - 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 Config</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: 'Config', 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=''>Config</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'>−</span>] |
| </a> |
| </span><a class='srclink' href='../../src/rustyline/config.rs.html#5-18' title='goto source code'>[src]</a></span></h1> |
| <pre class='rust struct'>pub struct Config { /* 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.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#20-57' title='goto source code'>[src]</a></span></h3> |
| <div class='impl-items'><h4 id='method.builder' class="method"><span id='builder.v' class='invisible'><code>fn <a href='#method.builder' class='fnname'>builder</a>() -> <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#21-23' 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) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rustyline/config.rs.html#26-28' title='goto source code'>[src]</a></span></h4> |
| <div class='docblock'><p>Tell the maximum length (i.e. number of entries) for the history.</p> |
| </div><h4 id='method.history_duplicates' class="method"><span id='history_duplicates.v' class='invisible'><code>fn <a href='#method.history_duplicates' class='fnname'>history_duplicates</a>(&self) -> <a class="enum" href="../../rustyline/config/enum.HistoryDuplicates.html" title="enum rustyline::config::HistoryDuplicates">HistoryDuplicates</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rustyline/config.rs.html#32-34' 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) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rustyline/config.rs.html#38-40' 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) -> <a class="enum" href="../../rustyline/config/enum.CompletionType.html" title="enum rustyline::config::CompletionType">CompletionType</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rustyline/config.rs.html#42-44' title='goto source code'>[src]</a></span></h4> |
| <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) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rustyline/config.rs.html#46-48' title='goto source code'>[src]</a></span></h4> |
| <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) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rustyline/config.rs.html#50-52' title='goto source code'>[src]</a></span></h4> |
| <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) -> <a class="enum" href="../../rustyline/config/enum.EditMode.html" title="enum rustyline::config::EditMode">EditMode</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rustyline/config.rs.html#54-56' 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/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <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#4' title='goto source code'>[src]</a></span></h3> |
| <div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> <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#4' title='goto source code'>[src]</a></span></h4> |
| <div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p> |
| </div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#112-114' title='goto source code'>[src]</a></span></h4> |
| <div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p> |
| </div></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> for <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#4' title='goto source code'>[src]</a></span></h3> |
| <div class='impl-items'></div><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.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#4' 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>(&self, __arg_0: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <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#4' 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/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a> for <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#4' title='goto source code'>[src]</a></span></h3> |
| <div class='impl-items'><h4 id='method.eq' class="method"><span id='eq.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq' class='fnname'>eq</a>(&self, __arg_0: &<a class="struct" href="../../rustyline/config/struct.Config.html" title="struct rustyline::config::Config">Config</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rustyline/config.rs.html#4' title='goto source code'>[src]</a></span></h4> |
| <div class='docblock'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p> |
| </div><h4 id='method.ne' class="method"><span id='ne.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne' class='fnname'>ne</a>(&self, __arg_0: &<a class="struct" href="../../rustyline/config/struct.Config.html" title="struct rustyline::config::Config">Config</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rustyline/config.rs.html#4' title='goto source code'>[src]</a></span></h4> |
| <div class='docblock'><p>This method tests for <code>!=</code>.</p> |
| </div></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> for <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#4' title='goto source code'>[src]</a></span></h3> |
| <div class='impl-items'></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.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#59-71' 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>() -> <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#60-70' title='goto source code'>[src]</a></span></h4> |
| <div class='docblock'><p>Returns the "default value" 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>⇤</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> |