blob: 4a19665fb2440473d3f53a304166d833cc201899 [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="IntoStreamer describes types that can be converted to streams."><meta name="keywords" content="rust, rustlang, rust-lang, IntoStreamer"><title>IntoStreamer in tantivy_fst - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../normalize.css"><link rel="stylesheet" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../ayu.css" disabled><link rel="stylesheet" href="../dark.css" disabled><link rel="stylesheet" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../tantivy_fst/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../tantivy_fst/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">IntoStreamer</a></h2><div class="sidebar-elems"><section><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Into">Into</a></li><li><a href="#associatedtype.Item">Item</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.into_stream">into_stream</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In tantivy_fst</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Trait <a href="index.html">tantivy_fst</a>::<wbr><a class="trait" href="#">IntoStreamer</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../src/tantivy_fst/stream.rs.html#113-121">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="item-decl"><pre class="rust trait"><code>pub trait IntoStreamer&lt;'a&gt; {
type <a href="#associatedtype.Item" class="associatedtype">Item</a>: 'a;
type <a href="#associatedtype.Into" class="associatedtype">Into</a>: <a class="trait" href="trait.Streamer.html" title="trait tantivy_fst::Streamer">Streamer</a>&lt;'a, Item = Self::<a class="associatedtype" href="trait.IntoStreamer.html#associatedtype.Item" title="type tantivy_fst::IntoStreamer::Item">Item</a>&gt;;
fn <a href="#tymethod.into_stream" class="fnname">into_stream</a>(self) -&gt; Self::<a class="associatedtype" href="trait.IntoStreamer.html#associatedtype.Into" title="type tantivy_fst::IntoStreamer::Into">Into</a>;
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><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></details><h2 id="required-associated-types" class="small-section-header">Required Associated Types<a href="#required-associated-types" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="associatedtype.Item" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy_fst/stream.rs.html#115">source</a><h4 class="code-header">type <a href="#associatedtype.Item" class="associatedtype">Item</a>: 'a</h4></section></summary><div class="docblock"><p>The type of the item emitted by the stream.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="associatedtype.Into" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy_fst/stream.rs.html#117">source</a><h4 class="code-header">type <a href="#associatedtype.Into" class="associatedtype">Into</a>: <a class="trait" href="trait.Streamer.html" title="trait tantivy_fst::Streamer">Streamer</a>&lt;'a, Item = Self::<a class="associatedtype" href="trait.IntoStreamer.html#associatedtype.Item" title="type tantivy_fst::IntoStreamer::Item">Item</a>&gt;</h4></section></summary><div class="docblock"><p>The type of the stream to be constructed.</p>
</div></details></div><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.into_stream" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy_fst/stream.rs.html#120">source</a><h4 class="code-header">fn <a href="#tymethod.into_stream" class="fnname">into_stream</a>(self) -&gt; Self::<a class="associatedtype" href="trait.IntoStreamer.html#associatedtype.Into" title="type tantivy_fst::IntoStreamer::Into">Into</a></h4></section></summary><div class="docblock"><p>Construct a stream from <code>Self</code>.</p>
</div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-IntoStreamer%3C%27a%3E-for-StreamWithStateBuilder%3C%27f%2C%20A%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/tantivy_fst/raw/mod.rs.html#656-673">source</a><a href="#impl-IntoStreamer%3C%27a%3E-for-StreamWithStateBuilder%3C%27f%2C%20A%3E" class="anchor"></a><h3 class="code-header">impl&lt;'a, 'f, A:&nbsp;'a + <a class="trait" href="automaton/trait.Automaton.html" title="trait tantivy_fst::automaton::Automaton">Automaton</a>&gt; <a class="trait" href="trait.IntoStreamer.html" title="trait tantivy_fst::IntoStreamer">IntoStreamer</a>&lt;'a&gt; for tantivy_fst::raw::<a class="struct" href="raw/struct.StreamWithStateBuilder.html" title="struct tantivy_fst::raw::StreamWithStateBuilder">StreamWithStateBuilder</a>&lt;'f, A&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;A::<a class="associatedtype" href="automaton/trait.Automaton.html#associatedtype.State" title="type tantivy_fst::automaton::Automaton::State">State</a>: Clone,</span></h3></section></summary><div class="impl-items"><section id="associatedtype.Item-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Item-1" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Item" class="associatedtype">Item</a> = (&amp;'a [u8], <a class="struct" href="raw/struct.Output.html" title="struct tantivy_fst::raw::Output">Output</a>, &lt;A as <a class="trait" href="automaton/trait.Automaton.html" title="trait tantivy_fst::automaton::Automaton">Automaton</a>&gt;::<a class="associatedtype" href="automaton/trait.Automaton.html#associatedtype.State" title="type tantivy_fst::automaton::Automaton::State">State</a>)</h4></section><section id="associatedtype.Into-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Into-1" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Into" class="associatedtype">Into</a> = <a class="struct" href="raw/struct.StreamWithState.html" title="struct tantivy_fst::raw::StreamWithState">StreamWithState</a>&lt;'f, A&gt;</h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-IntoStreamer%3C%27a%3E-for-StreamBuilder%3C%27f%2C%20A%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/tantivy_fst/raw/mod.rs.html#625-639">source</a><a href="#impl-IntoStreamer%3C%27a%3E-for-StreamBuilder%3C%27f%2C%20A%3E" class="anchor"></a><h3 class="code-header">impl&lt;'a, 'f, A:&nbsp;<a class="trait" href="automaton/trait.Automaton.html" title="trait tantivy_fst::automaton::Automaton">Automaton</a>&gt; <a class="trait" href="trait.IntoStreamer.html" title="trait tantivy_fst::IntoStreamer">IntoStreamer</a>&lt;'a&gt; for tantivy_fst::raw::<a class="struct" href="raw/struct.StreamBuilder.html" title="struct tantivy_fst::raw::StreamBuilder">StreamBuilder</a>&lt;'f, A&gt;</h3></section></summary><div class="impl-items"><section id="associatedtype.Item-2" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Item-2" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Item" class="associatedtype">Item</a> = (&amp;'a [u8], <a class="struct" href="raw/struct.Output.html" title="struct tantivy_fst::raw::Output">Output</a>)</h4></section><section id="associatedtype.Into-2" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Into-2" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Into" class="associatedtype">Into</a> = <a class="struct" href="raw/struct.Stream.html" title="struct tantivy_fst::raw::Stream">Stream</a>&lt;'f, A&gt;</h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-IntoStreamer%3C%27a%3E-for-%26%27f%20Fst%3CData%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/tantivy_fst/raw/mod.rs.html#542-553">source</a><a href="#impl-IntoStreamer%3C%27a%3E-for-%26%27f%20Fst%3CData%3E" class="anchor"></a><h3 class="code-header">impl&lt;'a, 'f, Data&gt; <a class="trait" href="trait.IntoStreamer.html" title="trait tantivy_fst::IntoStreamer">IntoStreamer</a>&lt;'a&gt; for &amp;'f <a class="struct" href="raw/struct.Fst.html" title="struct tantivy_fst::raw::Fst">Fst</a>&lt;Data&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Data: Deref&lt;Target = [u8]&gt;,</span></h3></section></summary><div class="impl-items"><section id="associatedtype.Item-3" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Item-3" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Item" class="associatedtype">Item</a> = (&amp;'a [u8], <a class="struct" href="raw/struct.Output.html" title="struct tantivy_fst::raw::Output">Output</a>)</h4></section><section id="associatedtype.Into-3" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Into-3" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Into" class="associatedtype">Into</a> = <a class="struct" href="raw/struct.Stream.html" title="struct tantivy_fst::raw::Stream">Stream</a>&lt;'f, <a class="struct" href="automaton/struct.AlwaysMatch.html" title="struct tantivy_fst::automaton::AlwaysMatch">AlwaysMatch</a>&gt;</h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-IntoStreamer%3C%27a%3E-for-S" class="impl has-srclink"><a class="srclink rightside" href="../src/tantivy_fst/stream.rs.html#123-130">source</a><a href="#impl-IntoStreamer%3C%27a%3E-for-S" class="anchor"></a><h3 class="code-header">impl&lt;'a, S:&nbsp;<a class="trait" href="trait.Streamer.html" title="trait tantivy_fst::Streamer">Streamer</a>&lt;'a&gt;&gt; <a class="trait" href="trait.IntoStreamer.html" title="trait tantivy_fst::IntoStreamer">IntoStreamer</a>&lt;'a&gt; for S</h3></section></summary><div class="impl-items"><section id="associatedtype.Item-4" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Item-4" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Item" class="associatedtype">Item</a> = &lt;S as <a class="trait" href="trait.Streamer.html" title="trait tantivy_fst::Streamer">Streamer</a>&lt;'a&gt;&gt;::<a class="associatedtype" href="trait.Streamer.html#associatedtype.Item" title="type tantivy_fst::Streamer::Item">Item</a></h4></section><section id="associatedtype.Into-4" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Into-4" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Into" class="associatedtype">Into</a> = S</h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-IntoStreamer%3C%27a%3E-for-StreamWithStateBuilder%3C%27m%2C%20A%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/tantivy_fst/map.rs.html#707-717">source</a><a href="#impl-IntoStreamer%3C%27a%3E-for-StreamWithStateBuilder%3C%27m%2C%20A%3E" class="anchor"></a><h3 class="code-header">impl&lt;'m, 'a, A:&nbsp;'a + <a class="trait" href="automaton/trait.Automaton.html" title="trait tantivy_fst::automaton::Automaton">Automaton</a>&gt; <a class="trait" href="trait.IntoStreamer.html" title="trait tantivy_fst::IntoStreamer">IntoStreamer</a>&lt;'a&gt; for tantivy_fst::map::<a class="struct" href="map/struct.StreamWithStateBuilder.html" title="struct tantivy_fst::map::StreamWithStateBuilder">StreamWithStateBuilder</a>&lt;'m, A&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;A::<a class="associatedtype" href="automaton/trait.Automaton.html#associatedtype.State" title="type tantivy_fst::automaton::Automaton::State">State</a>: Clone,</span></h3></section></summary><div class="impl-items"><section id="associatedtype.Item-5" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Item-5" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Item" class="associatedtype">Item</a> = (&amp;'a [u8], u64, &lt;A as <a class="trait" href="automaton/trait.Automaton.html" title="trait tantivy_fst::automaton::Automaton">Automaton</a>&gt;::<a class="associatedtype" href="automaton/trait.Automaton.html#associatedtype.State" title="type tantivy_fst::automaton::Automaton::State">State</a>)</h4></section><section id="associatedtype.Into-5" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Into-5" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Into" class="associatedtype">Into</a> = <a class="struct" href="map/struct.StreamWithState.html" title="struct tantivy_fst::map::StreamWithState">StreamWithState</a>&lt;'m, A&gt;</h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-IntoStreamer%3C%27a%3E-for-StreamBuilder%3C%27m%2C%20A%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/tantivy_fst/map.rs.html#683-690">source</a><a href="#impl-IntoStreamer%3C%27a%3E-for-StreamBuilder%3C%27m%2C%20A%3E" class="anchor"></a><h3 class="code-header">impl&lt;'m, 'a, A:&nbsp;<a class="trait" href="automaton/trait.Automaton.html" title="trait tantivy_fst::automaton::Automaton">Automaton</a>&gt; <a class="trait" href="trait.IntoStreamer.html" title="trait tantivy_fst::IntoStreamer">IntoStreamer</a>&lt;'a&gt; for tantivy_fst::map::<a class="struct" href="map/struct.StreamBuilder.html" title="struct tantivy_fst::map::StreamBuilder">StreamBuilder</a>&lt;'m, A&gt;</h3></section></summary><div class="impl-items"><section id="associatedtype.Item-6" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Item-6" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Item" class="associatedtype">Item</a> = (&amp;'a [u8], u64)</h4></section><section id="associatedtype.Into-6" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Into-6" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Into" class="associatedtype">Into</a> = <a class="struct" href="map/struct.Stream.html" title="struct tantivy_fst::map::Stream">Stream</a>&lt;'m, A&gt;</h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-IntoStreamer%3C%27a%3E-for-%26%27m%20Map%3CData%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/tantivy_fst/map.rs.html#392-400">source</a><a href="#impl-IntoStreamer%3C%27a%3E-for-%26%27m%20Map%3CData%3E" class="anchor"></a><h3 class="code-header">impl&lt;'m, 'a, Data:&nbsp;Deref&lt;Target = [u8]&gt;&gt; <a class="trait" href="trait.IntoStreamer.html" title="trait tantivy_fst::IntoStreamer">IntoStreamer</a>&lt;'a&gt; for &amp;'m <a class="struct" href="map/struct.Map.html" title="struct tantivy_fst::map::Map">Map</a>&lt;Data&gt;</h3></section></summary><div class="impl-items"><section id="associatedtype.Item-7" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Item-7" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Item" class="associatedtype">Item</a> = (&amp;'a [u8], u64)</h4></section><section id="associatedtype.Into-7" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Into-7" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Into" class="associatedtype">Into</a> = <a class="struct" href="map/struct.Stream.html" title="struct tantivy_fst::map::Stream">Stream</a>&lt;'m, <a class="struct" href="automaton/struct.AlwaysMatch.html" title="struct tantivy_fst::automaton::AlwaysMatch">AlwaysMatch</a>&gt;</h4></section></div></details></div><script src="../implementors/tantivy_fst/stream/trait.IntoStreamer.js" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="tantivy_fst" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>