| <!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 `FilenameCompleter` struct in crate `rustyline`."> |
| <meta name="keywords" content="rust, rustlang, rust-lang, FilenameCompleter"> |
| |
| <title>rustyline::completion::FilenameCompleter - 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 FilenameCompleter</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'>completion</a></p><script>window.sidebarCurrent = {name: 'FilenameCompleter', 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'>completion</a>::<wbr><a class="struct" href=''>FilenameCompleter</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/completion.rs.html#64-66' title='goto source code'>[src]</a></span></h1> |
| <pre class='rust struct'>pub struct FilenameCompleter { /* fields omitted */ }</pre><div class='docblock'><p>A <code>Completer</code> for file and folder names.</p> |
| </div> |
| <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/completion/struct.FilenameCompleter.html" title="struct rustyline::completion::FilenameCompleter">FilenameCompleter</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rustyline/completion.rs.html#80-84' 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>() -> <a class="struct" href="../../rustyline/completion/struct.FilenameCompleter.html" title="struct rustyline::completion::FilenameCompleter">FilenameCompleter</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rustyline/completion.rs.html#81-83' 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/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="../../rustyline/completion/struct.FilenameCompleter.html" title="struct rustyline::completion::FilenameCompleter">FilenameCompleter</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rustyline/completion.rs.html#86-90' 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/completion/struct.FilenameCompleter.html" title="struct rustyline::completion::FilenameCompleter">FilenameCompleter</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rustyline/completion.rs.html#87-89' 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><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="../../rustyline/completion/trait.Completer.html" title="trait rustyline::completion::Completer">Completer</a> for <a class="struct" href="../../rustyline/completion/struct.FilenameCompleter.html" title="struct rustyline::completion::FilenameCompleter">FilenameCompleter</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rustyline/completion.rs.html#92-99' title='goto source code'>[src]</a></span></h3> |
| <div class='impl-items'><h4 id='method.complete' class="method"><span id='complete.v' class='invisible'><code>fn <a href='../../rustyline/completion/trait.Completer.html#tymethod.complete' class='fnname'>complete</a>(&self, line: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, pos: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="type" href="../../rustyline/type.Result.html" title="type rustyline::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rustyline/completion.rs.html#93-98' title='goto source code'>[src]</a></span></h4> |
| <div class='docblock'><p>Takes the currently edited <code>line</code> with the cursor <code>pos</code>ition and returns the start position and the completion candidates for the partial word to be completed. "ls /usr/loc" => Ok((3, vec!["/usr/local/"])) <a href="../../rustyline/completion/trait.Completer.html#tymethod.complete">Read more</a></p> |
| </div><h4 id='method.update' class="method"><span id='update.v' class='invisible'><code>fn <a href='../../rustyline/completion/trait.Completer.html#method.update' class='fnname'>update</a>(&self, line: &mut <a class="struct" href="../../rustyline/line_buffer/struct.LineBuffer.html" title="struct rustyline::line_buffer::LineBuffer">LineBuffer</a>, start: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, elected: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>)</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rustyline/completion.rs.html#21-24' title='goto source code'>[src]</a></span></h4> |
| <div class='docblock'><p>Updates the edited <code>line</code> with the <code>elected</code> candidate.</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> |