mirror of
https://github.com/quickwit-oss/tantivy.git
synced 2026-05-21 02:30:43 +00:00
35 lines
15 KiB
HTML
35 lines
15 KiB
HTML
<!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 `IntoStreamer` trait in crate `fst`."><meta name="keywords" content="rust, rustlang, rust-lang, IntoStreamer"><title>fst::IntoStreamer - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script></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"><div class="sidebar-menu">☰</div><p class='location'>Trait IntoStreamer</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-types">Associated Types</a><div class="sidebar-links"><a href="#associatedtype.Item">Item</a><a href="#associatedtype.Into">Into</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.into_stream">into_stream</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>fst</a></p><script>window.sidebarCurrent = {name: 'IntoStreamer', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><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"><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='in-band'>Trait <a href='index.html'>fst</a>::<wbr><a class="trait" href=''>IntoStreamer</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/fst/stream.rs.html#113-121' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust trait'>pub trait IntoStreamer<'a> {
|
||
type <a href='#associatedtype.Item' class="type">Item</a>: 'a;
|
||
type <a href='#associatedtype.Into' class="type">Into</a>: <a class="trait" href="../fst/trait.Streamer.html" title="trait fst::Streamer">Streamer</a><'a, Item = Self::<a class="type" href="../fst/trait.IntoStreamer.html#associatedtype.Item" title="type fst::IntoStreamer::Item">Item</a>>;
|
||
fn <a href='#tymethod.into_stream' class='fnname'>into_stream</a>(self) -> Self::<a class="type" href="../fst/trait.IntoStreamer.html#associatedtype.Into" title="type fst::IntoStreamer::Into">Into</a>;
|
||
}</pre></div><div class='docblock'><p>IntoStreamer describes types that can be converted to streams.</p>
|
||
<p>This is analogous to the <code>IntoIterator</code> trait for <code>Iterator</code> in
|
||
<code>std::iter</code>.</p>
|
||
</div>
|
||
<h2 id='associated-types' class='small-section-header'>
|
||
Associated Types<a href='#associated-types' class='anchor'></a>
|
||
</h2>
|
||
<div class='methods'>
|
||
<h3 id='associatedtype.Item' class='method'><span id='Item.t' class='invisible'><code>type <a href='#associatedtype.Item' class="type">Item</a>: 'a</code></span></h3><div class='docblock'><p>The type of the item emitted by the stream.</p>
|
||
</div><h3 id='associatedtype.Into' class='method'><span id='Into.t' class='invisible'><code>type <a href='#associatedtype.Into' class="type">Into</a>: <a class="trait" href="../fst/trait.Streamer.html" title="trait fst::Streamer">Streamer</a><'a, Item = Self::<a class="type" href="../fst/trait.IntoStreamer.html#associatedtype.Item" title="type fst::IntoStreamer::Item">Item</a>></code></span></h3><div class='docblock'><p>The type of the stream to be constructed.</p>
|
||
</div></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.into_stream' class='method'><span id='into_stream.v' class='invisible'><code>fn <a href='#tymethod.into_stream' class='fnname'>into_stream</a>(self) -> Self::<a class="type" href="../fst/trait.IntoStreamer.html#associatedtype.Into" title="type fst::IntoStreamer::Into">Into</a></code></span></h3><div class='docblock'><p>Construct a stream from <code>Self</code>.</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><table class='table-display'><tbody><tr><td><code>impl<'m, 'a> IntoStreamer<'a> for &'m <a class="struct" href="../fst/struct.Map.html" title="struct fst::Map">Map</a><span class="where fmt-newline"> type <a href='#associatedtype.Item' class="type">Item</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.slice.html">&'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>;</span><span class="where fmt-newline"> type <a href='#associatedtype.Into' class="type">Into</a> = <a class="struct" href="../fst/map/struct.Stream.html" title="struct fst::map::Stream">Stream</a><'m>;</span></code><td><div class='out-of-band'><a class='srclink' href='../src/fst/map.rs.html#394-401' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
|
||
<li><table class='table-display'><tbody><tr><td><code>impl<'m, 'a, A: <a class="trait" href="../fst/automaton/trait.Automaton.html" title="trait fst::automaton::Automaton">Automaton</a>> IntoStreamer<'a> for fst::map::<a class="struct" href="../fst/map/struct.StreamBuilder.html" title="struct fst::map::StreamBuilder">StreamBuilder</a><'m, A><span class="where fmt-newline"> type <a href='#associatedtype.Item' class="type">Item</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.slice.html">&'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>;</span><span class="where fmt-newline"> type <a href='#associatedtype.Into' class="type">Into</a> = <a class="struct" href="../fst/map/struct.Stream.html" title="struct fst::map::Stream">Stream</a><'m, A>;</span></code><td><div class='out-of-band'><a class='srclink' href='../src/fst/map.rs.html#698-705' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
|
||
<li><table class='table-display'><tbody><tr><td><code>impl<'a, 'f> IntoStreamer<'a> for &'f <a class="struct" href="../fst/raw/struct.Fst.html" title="struct fst::raw::Fst">Fst</a><span class="where fmt-newline"> type <a href='#associatedtype.Item' class="type">Item</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.slice.html">&'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, <a class="struct" href="../fst/raw/struct.Output.html" title="struct fst::raw::Output">Output</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>;</span><span class="where fmt-newline"> type <a href='#associatedtype.Into' class="type">Into</a> = <a class="struct" href="../fst/raw/struct.Stream.html" title="struct fst::raw::Stream">Stream</a><'f>;</span></code><td><div class='out-of-band'><a class='srclink' href='../src/fst/raw/mod.rs.html#566-573' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
|
||
<li><table class='table-display'><tbody><tr><td><code>impl<'a, 'f, A: <a class="trait" href="../fst/automaton/trait.Automaton.html" title="trait fst::automaton::Automaton">Automaton</a>> IntoStreamer<'a> for fst::raw::<a class="struct" href="../fst/raw/struct.StreamBuilder.html" title="struct fst::raw::StreamBuilder">StreamBuilder</a><'f, A><span class="where fmt-newline"> type <a href='#associatedtype.Item' class="type">Item</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.slice.html">&'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, <a class="struct" href="../fst/raw/struct.Output.html" title="struct fst::raw::Output">Output</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>;</span><span class="where fmt-newline"> type <a href='#associatedtype.Into' class="type">Into</a> = <a class="struct" href="../fst/raw/struct.Stream.html" title="struct fst::raw::Stream">Stream</a><'f, A>;</span></code><td><div class='out-of-band'><a class='srclink' href='../src/fst/raw/mod.rs.html#629-636' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
|
||
<li><table class='table-display'><tbody><tr><td><code>impl<'s, 'a> IntoStreamer<'a> for &'s <a class="struct" href="../fst/struct.Set.html" title="struct fst::Set">Set</a><span class="where fmt-newline"> type <a href='#associatedtype.Item' class="type">Item</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>;</span><span class="where fmt-newline"> type <a href='#associatedtype.Into' class="type">Into</a> = <a class="struct" href="../fst/set/struct.Stream.html" title="struct fst::set::Stream">Stream</a><'s>;</span></code><td><div class='out-of-band'><a class='srclink' href='../src/fst/set.rs.html#340-347' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
|
||
<li><table class='table-display'><tbody><tr><td><code>impl<'s, 'a, A: <a class="trait" href="../fst/automaton/trait.Automaton.html" title="trait fst::automaton::Automaton">Automaton</a>> IntoStreamer<'a> for fst::set::<a class="struct" href="../fst/set/struct.StreamBuilder.html" title="struct fst::set::StreamBuilder">StreamBuilder</a><'s, A><span class="where fmt-newline"> type <a href='#associatedtype.Item' class="type">Item</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>;</span><span class="where fmt-newline"> type <a href='#associatedtype.Into' class="type">Into</a> = <a class="struct" href="../fst/set/struct.Stream.html" title="struct fst::set::Stream">Stream</a><'s, A>;</span></code><td><div class='out-of-band'><a class='srclink' href='../src/fst/set.rs.html#594-601' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
|
||
<li><table class='table-display'><tbody><tr><td><code>impl<'a, S: <a class="trait" href="../fst/trait.Streamer.html" title="trait fst::Streamer">Streamer</a><'a>> IntoStreamer<'a> for S<span class="where fmt-newline"> type <a href='#associatedtype.Item' class="type">Item</a> = S::<a class="type" href="../fst/trait.Streamer.html#associatedtype.Item" title="type fst::Streamer::Item">Item</a>;</span><span class="where fmt-newline"> type <a href='#associatedtype.Into' class="type">Into</a> = S;</span></code><td><div class='out-of-band'><a class='srclink' href='../src/fst/stream.rs.html#123-130' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
|
||
</ul><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
|
||
src="../implementors/fst/trait.IntoStreamer.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><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse 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><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "fst";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |