| <!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="A builder for constructing range queries of streams that returns results along with automaton states."><meta name="keywords" content="rust, rustlang, rust-lang, StreamWithStateBuilder"><title>StreamWithStateBuilder in tantivy_fst::map - 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 struct"><!--[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">☰</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="#">StreamWithStateBuilder</a></h2><div class="sidebar-elems"><section><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-IntoStreamer%3C%27a%3E-for-StreamWithStateBuilder%3C%27m%2C%20A%3E">IntoStreamer<'a></a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-StreamWithStateBuilder%3C%27m%2C%20A%3E">RefUnwindSafe</a></li><li><a href="#impl-Send-for-StreamWithStateBuilder%3C%27m%2C%20A%3E">Send</a></li><li><a href="#impl-Sync-for-StreamWithStateBuilder%3C%27m%2C%20A%3E">Sync</a></li><li><a href="#impl-Unpin-for-StreamWithStateBuilder%3C%27m%2C%20A%3E">Unpin</a></li><li><a href="#impl-UnwindSafe-for-StreamWithStateBuilder%3C%27m%2C%20A%3E">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-StreamWithStateBuilder%3C%27m%2C%20A%3E">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-StreamWithStateBuilder%3C%27m%2C%20A%3E">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-StreamWithStateBuilder%3C%27m%2C%20A%3E">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-StreamWithStateBuilder%3C%27m%2C%20A%3E">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-StreamWithStateBuilder%3C%27m%2C%20A%3E">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-StreamWithStateBuilder%3C%27m%2C%20A%3E">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-StreamWithStateBuilder%3C%27m%2C%20A%3E">TryInto<U></a></li></ul></section><h2><a href="index.html">In tantivy_fst::map</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">Struct <a href="../index.html">tantivy_fst</a>::<wbr><a href="index.html">map</a>::<wbr><a class="struct" href="#">StreamWithStateBuilder</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/map.rs.html#705">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust struct"><code>pub struct StreamWithStateBuilder<'m, A = <a class="struct" href="../automaton/struct.AlwaysMatch.html" title="struct tantivy_fst::automaton::AlwaysMatch">AlwaysMatch</a>>(_);</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A builder for constructing range queries of streams |
| that returns results along with automaton states.</p> |
| <p>Once all bounds are set, one should call <code>into_stream</code> to get a |
| <code>StreamWithState</code>.</p> |
| <p>Bounds are not additive. That is, if <code>ge</code> is called twice on the same |
| builder, then the second setting wins.</p> |
| <p>The <code>A</code> type parameter corresponds to an optional automaton to filter |
| the stream. By default, no filtering is done.</p> |
| <p>The <code>'m</code> lifetime parameter refers to the lifetime of the underlying map.</p> |
| </div></details><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><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<'m, 'a, A: 'a + <a class="trait" href="../automaton/trait.Automaton.html" title="trait tantivy_fst::automaton::Automaton">Automaton</a>> <a class="trait" href="../trait.IntoStreamer.html" title="trait tantivy_fst::IntoStreamer">IntoStreamer</a><'a> for <a class="struct" href="struct.StreamWithStateBuilder.html" title="struct tantivy_fst::map::StreamWithStateBuilder">StreamWithStateBuilder</a><'m, A><span class="where fmt-newline">where<br> 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"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Item" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Item" class="anchor"></a><h4 class="code-header">type <a href="../trait.IntoStreamer.html#associatedtype.Item" class="associatedtype">Item</a> = (&'a [u8], u64, <A as <a class="trait" href="../automaton/trait.Automaton.html" title="trait tantivy_fst::automaton::Automaton">Automaton</a>>::<a class="associatedtype" href="../automaton/trait.Automaton.html#associatedtype.State" title="type tantivy_fst::automaton::Automaton::State">State</a>)</h4></section></summary><div class='docblock'>The type of the item emitted by the stream.</div></details><details class="rustdoc-toggle" open><summary><section id="associatedtype.Into" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Into" class="anchor"></a><h4 class="code-header">type <a href="../trait.IntoStreamer.html#associatedtype.Into" class="associatedtype">Into</a> = <a class="struct" href="struct.StreamWithState.html" title="struct tantivy_fst::map::StreamWithState">StreamWithState</a><'m, A></h4></section></summary><div class='docblock'>The type of the stream to be constructed.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into_stream" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tantivy_fst/map.rs.html#714-716">source</a><a href="#method.into_stream" class="anchor"></a><h4 class="code-header">fn <a href="../trait.IntoStreamer.html#tymethod.into_stream" class="fnname">into_stream</a>(self) -> Self::<a class="associatedtype" href="../trait.IntoStreamer.html#associatedtype.Into" title="type tantivy_fst::IntoStreamer::Into">Into</a></h4></section></summary><div class='docblock'>Construct a stream from <code>Self</code>.</div></details></div></details></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-StreamWithStateBuilder%3C%27m%2C%20A%3E" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-StreamWithStateBuilder%3C%27m%2C%20A%3E" class="anchor"></a><h3 class="code-header">impl<'m, A> RefUnwindSafe for <a class="struct" href="struct.StreamWithStateBuilder.html" title="struct tantivy_fst::map::StreamWithStateBuilder">StreamWithStateBuilder</a><'m, A><span class="where fmt-newline">where<br> A: RefUnwindSafe,</span></h3></section><section id="impl-Send-for-StreamWithStateBuilder%3C%27m%2C%20A%3E" class="impl has-srclink"><a href="#impl-Send-for-StreamWithStateBuilder%3C%27m%2C%20A%3E" class="anchor"></a><h3 class="code-header">impl<'m, A> Send for <a class="struct" href="struct.StreamWithStateBuilder.html" title="struct tantivy_fst::map::StreamWithStateBuilder">StreamWithStateBuilder</a><'m, A><span class="where fmt-newline">where<br> A: Send,</span></h3></section><section id="impl-Sync-for-StreamWithStateBuilder%3C%27m%2C%20A%3E" class="impl has-srclink"><a href="#impl-Sync-for-StreamWithStateBuilder%3C%27m%2C%20A%3E" class="anchor"></a><h3 class="code-header">impl<'m, A> Sync for <a class="struct" href="struct.StreamWithStateBuilder.html" title="struct tantivy_fst::map::StreamWithStateBuilder">StreamWithStateBuilder</a><'m, A><span class="where fmt-newline">where<br> A: Sync,</span></h3></section><section id="impl-Unpin-for-StreamWithStateBuilder%3C%27m%2C%20A%3E" class="impl has-srclink"><a href="#impl-Unpin-for-StreamWithStateBuilder%3C%27m%2C%20A%3E" class="anchor"></a><h3 class="code-header">impl<'m, A> Unpin for <a class="struct" href="struct.StreamWithStateBuilder.html" title="struct tantivy_fst::map::StreamWithStateBuilder">StreamWithStateBuilder</a><'m, A><span class="where fmt-newline">where<br> A: Unpin,</span></h3></section><section id="impl-UnwindSafe-for-StreamWithStateBuilder%3C%27m%2C%20A%3E" class="impl has-srclink"><a href="#impl-UnwindSafe-for-StreamWithStateBuilder%3C%27m%2C%20A%3E" class="anchor"></a><h3 class="code-header">impl<'m, A> UnwindSafe for <a class="struct" href="struct.StreamWithStateBuilder.html" title="struct tantivy_fst::map::StreamWithStateBuilder">StreamWithStateBuilder</a><'m, A><span class="where fmt-newline">where<br> A: UnwindSafe,</span></h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any-for-StreamWithStateBuilder%3C%27m%2C%20A%3E" class="impl has-srclink"><a href="#impl-Any-for-StreamWithStateBuilder%3C%27m%2C%20A%3E" class="anchor"></a><h3 class="code-header">impl<T> Any for T<span class="where fmt-newline">where<br> T: 'static + ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a class="fnname">type_id</a>(&self) -> TypeId</h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-StreamWithStateBuilder%3C%27m%2C%20A%3E" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-StreamWithStateBuilder%3C%27m%2C%20A%3E" class="anchor"></a><h3 class="code-header">impl<T> Borrow<T> for T<span class="where fmt-newline">where<br> T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow</a>(&self) -> &T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-StreamWithStateBuilder%3C%27m%2C%20A%3E" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-StreamWithStateBuilder%3C%27m%2C%20A%3E" class="anchor"></a><h3 class="code-header">impl<T> BorrowMut<T> for T<span class="where fmt-newline">where<br> T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow_mut</a>(&mut self) -> &mut T</h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-StreamWithStateBuilder%3C%27m%2C%20A%3E" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-StreamWithStateBuilder%3C%27m%2C%20A%3E" class="anchor"></a><h3 class="code-header">impl<T> From<T> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-StreamWithStateBuilder%3C%27m%2C%20A%3E" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-StreamWithStateBuilder%3C%27m%2C%20A%3E" class="anchor"></a><h3 class="code-header">impl<T, U> Into<U> for T<span class="where fmt-newline">where<br> U: From<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p> |
| <p>That is, this conversion is whatever the implementation of |
| <code>[From]<T> for U</code> chooses to do.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-StreamWithStateBuilder%3C%27m%2C%20A%3E" class="impl has-srclink"><a href="#impl-TryFrom%3CU%3E-for-StreamWithStateBuilder%3C%27m%2C%20A%3E" class="anchor"></a><h3 class="code-header">impl<T, U> TryFrom<U> for T<span class="where fmt-newline">where<br> U: Into<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = Infallible</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_from</a>(value: U) -> Result<T, <T as TryFrom<U>>::Error></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-StreamWithStateBuilder%3C%27m%2C%20A%3E" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-StreamWithStateBuilder%3C%27m%2C%20A%3E" class="anchor"></a><h3 class="code-header">impl<T, U> TryInto<U> for T<span class="where fmt-newline">where<br> U: TryFrom<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = <U as TryFrom<T>>::Error</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_into</a>(self) -> Result<U, <U as TryFrom<T>>::Error></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></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> |
