| <!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 `Completer` trait in crate `rustyline`."> |
| <meta name="keywords" content="rust, rustlang, rust-lang, Completer"> |
| |
| <title>rustyline::completion::Completer - 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 trait"> |
| <!--[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'>Trait Completer</p><div class="block items"><ul><li><a href="#required-methods">Required Methods</a></li><li><a href="#provided-methods">Provided Methods</a></li><li><a href="#implementors">Implementors</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: 'Completer', ty: 'trait', 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'>Trait <a href='../index.html'>rustyline</a>::<wbr><a href='index.html'>completion</a>::<wbr><a class="trait" href=''>Completer</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#15-25' title='goto source code'>[src]</a></span></h1> |
| <pre class='rust trait'>pub trait Completer { |
| fn <a href='#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>>; |
| |
| fn <a href='#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>) { ... } |
| }</pre><div class='docblock'><p>To be called for tab-completion.</p> |
| </div> |
| <h2 id='required-methods' class='small-section-header'> |
| Required Methods<a href='#required-methods' class='anchor'></a> |
| </h2> |
| <div class='methods'> |
| <h3 id='tymethod.complete' class='method'><span id='complete.v' class='invisible'><code>fn <a href='#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></h3><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/"]))</p> |
| </div></div> |
| <h2 id='provided-methods' class='small-section-header'> |
| Provided Methods<a href='#provided-methods' class='anchor'></a> |
| </h2> |
| <div class='methods'> |
| <h3 id='method.update' class='method'><span id='update.v' class='invisible'><code>fn <a href='#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></h3><div class='docblock'><p>Updates the edited <code>line</code> with the <code>elected</code> candidate.</p> |
| </div></div> |
| <h2 id='implementors' class='small-section-header'> |
| Implementors<a href='#implementors' class='anchor'></a> |
| </h2> |
| <ul class='item-list' id='implementors-list'> |
| <li><code>impl Completer for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a></code></li> |
| <li><code>impl<'c, C: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../../rustyline/completion/trait.Completer.html" title="trait rustyline::completion::Completer">Completer</a>> Completer for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'c </a>C</code></li> |
| <li><code>impl<C: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../../rustyline/completion/trait.Completer.html" title="trait rustyline::completion::Completer">Completer</a>> Completer for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><C></code></li> |
| <li><code>impl<C: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../../rustyline/completion/trait.Completer.html" title="trait rustyline::completion::Completer">Completer</a>> Completer for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/rc/struct.Rc.html" title="struct alloc::rc::Rc">Rc</a><C></code></li> |
| <li><code>impl<C: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="../../rustyline/completion/trait.Completer.html" title="trait rustyline::completion::Completer">Completer</a>> Completer for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/arc/struct.Arc.html" title="struct alloc::arc::Arc">Arc</a><C></code></li> |
| <li><code>impl Completer for <a class="struct" href="../../rustyline/completion/struct.FilenameCompleter.html" title="struct rustyline::completion::FilenameCompleter">FilenameCompleter</a></code></li> |
| </ul><script type="text/javascript" async |
| src="../../implementors/rustyline/completion/trait.Completer.js"> |
| </script></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> |
