rust/tantivy
1
0
Fork 0
mirror of https://github.com/quickwit-oss/tantivy.git synced 2026-05-27 13:40:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Automatic Travis documentation build

Browse Source
This commit is contained in:
Travis CI User
2018-02-20 04:24:56 +00:00
parent ae8247e83d
commit 16cdcdba16
3 changed files with 27 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
master/search-index.js
View File

File diff suppressed because one or more lines are too long

10
master/src/tantivy/indexer/index_writer.rs.html
View File

@@ -894,6 +894,10 @@
<span id="838">838</span>
<span id="839">839</span>
<span id="840">840</span>
<span id="841">841</span>
<span id="842">842</span>
<span id="843">843</span>
<span id="844">844</span>
</pre><pre class="rust ">
<span class="kw">use</span> <span class="ident">bit_set</span>::<span class="ident">BitSet</span>;
<span class="kw">use</span> <span class="ident">chan</span>;
@@ -1256,7 +1260,11 @@
.<span class="ident">add_segment</span>(<span class="self">self</span>.<span class="ident">generation</span>, <span class="ident">segment_entry</span>);
}
<span class="attribute">#[<span class="ident">doc</span>(<span class="ident">hidden</span>)]</span>
<span class="doccomment">/// *Experimental &amp; Advanced API* Creates a new segment.</span>
<span class="doccomment">/// and marks it as currently in write.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This method is useful only for users trying to do complex</span>
<span class="doccomment">/// operations, like converting an index format to another.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new_segment</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) <span class="op">-&gt;</span> <span class="ident">Segment</span> {
<span class="self">self</span>.<span class="ident">segment_updater</span>.<span class="ident">new_segment</span>()
}

29
master/tantivy/struct.IndexWriter.html
View File

@@ -33,7 +33,7 @@
<nav class="sidebar">
<div class="sidebar-menu">&#9776;</div>
<a href='../tantivy/index.html'><img src='http://fulmicoton.com/tantivy-logo/tantivy-logo.png' alt='logo' width='100'></a>
<p class='location'>Struct IndexWriter</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.wait_merging_threads">wait_merging_threads</a><a href="#method.get_merge_policy">get_merge_policy</a><a href="#method.set_merge_policy">set_merge_policy</a><a href="#method.garbage_collect_files">garbage_collect_files</a><a href="#method.merge">merge</a><a href="#method.rollback">rollback</a><a href="#method.prepare_commit">prepare_commit</a><a href="#method.commit">commit</a><a href="#method.delete_term">delete_term</a><a href="#method.commit_opstamp">commit_opstamp</a><a href="#method.add_document">add_document</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">!Send</a><a href="#impl-Sync">!Sync</a></div></div><p class='location'><a href='index.html'>tantivy</a></p><script>window.sidebarCurrent = {name: 'IndexWriter', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div>
<p class='location'>Struct IndexWriter</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.wait_merging_threads">wait_merging_threads</a><a href="#method.new_segment">new_segment</a><a href="#method.get_merge_policy">get_merge_policy</a><a href="#method.set_merge_policy">set_merge_policy</a><a href="#method.garbage_collect_files">garbage_collect_files</a><a href="#method.merge">merge</a><a href="#method.rollback">rollback</a><a href="#method.prepare_commit">prepare_commit</a><a href="#method.commit">commit</a><a href="#method.delete_term">delete_term</a><a href="#method.commit_opstamp">commit_opstamp</a><a href="#method.add_document">add_document</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">!Send</a><a href="#impl-Sync">!Sync</a></div></div><p class='location'><a href='index.html'>tantivy</a></p><script>window.sidebarCurrent = {name: 'IndexWriter', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div>
</nav>
<div class="theme-picker">
@@ -69,26 +69,31 @@ a <code>SegmentWriter</code> object.</p>
<h2 id='methods' class='small-section-header'>
Methods<a href='#methods' class='anchor'></a>
</h2>
<h3 id='impl' class='impl'><span class='in-band'><code>impl <a class="struct" href="../tantivy/struct.IndexWriter.html" title="struct tantivy::IndexWriter">IndexWriter</a></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tantivy/indexer/index_writer.rs.html#327-641' title='goto source code'>[src]</a></span></h3>
<h3 id='impl' class='impl'><span class='in-band'><code>impl <a class="struct" href="../tantivy/struct.IndexWriter.html" title="struct tantivy::IndexWriter">IndexWriter</a></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tantivy/indexer/index_writer.rs.html#327-645' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.wait_merging_threads' class="method"><span id='wait_merging_threads.v' class='invisible'><code>pub fn <a href='#method.wait_merging_threads' class='fnname'>wait_merging_threads</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../tantivy/struct.Error.html" title="struct tantivy::Error">Error</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tantivy/indexer/index_writer.rs.html#329-352' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>The index writer</p>
</div><h4 id='method.get_merge_policy' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;R&gt;</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;R&gt;</h3><code class="content"><span class="where fmt-newline">impl&lt;R&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;R&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></span><span class="where fmt-newline">impl&lt;W&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;W&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;W: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></span><span class="where fmt-newline">impl&lt;I&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;I&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = &lt;I as <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a>&gt;::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item" title="type core::iter::iterator::Iterator::Item">Item</a>;</span></code></div></div><span id='get_merge_policy.v' class='invisible'><code>pub fn <a href='#method.get_merge_policy' class='fnname'>get_merge_policy</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;<a class="trait" href="../tantivy/merge_policy/trait.MergePolicy.html" title="trait tantivy::merge_policy::MergePolicy">MergePolicy</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tantivy/indexer/index_writer.rs.html#424-426' title='goto source code'>[src]</a></span></h4>
</div><h4 id='method.new_segment' class="method"><span id='new_segment.v' class='invisible'><code>pub fn <a href='#method.new_segment' class='fnname'>new_segment</a>(&amp;self) -&gt; <a class="struct" href="../tantivy/struct.Segment.html" title="struct tantivy::Segment">Segment</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tantivy/indexer/index_writer.rs.html#367-369' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p><em>Experimental &amp; Advanced API</em> Creates a new segment.
and marks it as currently in write.</p>
<p>This method is useful only for users trying to do complex
operations, like converting an index format to another.</p>
</div><h4 id='method.get_merge_policy' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;R&gt;</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;R&gt;</h3><code class="content"><span class="where fmt-newline">impl&lt;R&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;R&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></span><span class="where fmt-newline">impl&lt;W&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;W&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;W: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></span><span class="where fmt-newline">impl&lt;I&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;I&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = &lt;I as <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a>&gt;::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item" title="type core::iter::iterator::Iterator::Item">Item</a>;</span></code></div></div><span id='get_merge_policy.v' class='invisible'><code>pub fn <a href='#method.get_merge_policy' class='fnname'>get_merge_policy</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;<a class="trait" href="../tantivy/merge_policy/trait.MergePolicy.html" title="trait tantivy::merge_policy::MergePolicy">MergePolicy</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tantivy/indexer/index_writer.rs.html#428-430' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Accessor to the merge policy.</p>
</div><h4 id='method.set_merge_policy' class="method"><span id='set_merge_policy.v' class='invisible'><code>pub fn <a href='#method.set_merge_policy' class='fnname'>set_merge_policy</a>(&amp;self, merge_policy: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;<a class="trait" href="../tantivy/merge_policy/trait.MergePolicy.html" title="trait tantivy::merge_policy::MergePolicy">MergePolicy</a>&gt;)</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tantivy/indexer/index_writer.rs.html#429-431' title='goto source code'>[src]</a></span></h4>
</div><h4 id='method.set_merge_policy' class="method"><span id='set_merge_policy.v' class='invisible'><code>pub fn <a href='#method.set_merge_policy' class='fnname'>set_merge_policy</a>(&amp;self, merge_policy: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;<a class="trait" href="../tantivy/merge_policy/trait.MergePolicy.html" title="trait tantivy::merge_policy::MergePolicy">MergePolicy</a>&gt;)</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tantivy/indexer/index_writer.rs.html#433-435' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Set the merge policy.</p>
</div><h4 id='method.garbage_collect_files' class="method"><span id='garbage_collect_files.v' class='invisible'><code>pub fn <a href='#method.garbage_collect_files' class='fnname'>garbage_collect_files</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../tantivy/struct.Error.html" title="struct tantivy::Error">Error</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tantivy/indexer/index_writer.rs.html#442-444' title='goto source code'>[src]</a></span></h4>
</div><h4 id='method.garbage_collect_files' class="method"><span id='garbage_collect_files.v' class='invisible'><code>pub fn <a href='#method.garbage_collect_files' class='fnname'>garbage_collect_files</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../tantivy/struct.Error.html" title="struct tantivy::Error">Error</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tantivy/indexer/index_writer.rs.html#446-448' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Detects and removes the files that
are not used by the index anymore.</p>
</div><h4 id='method.merge' class="method"><span id='merge.v' class='invisible'><code>pub fn <a href='#method.merge' class='fnname'>merge</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;segment_ids: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;[</a><a class="struct" href="../tantivy/struct.SegmentId.html" title="struct tantivy::SegmentId">SegmentId</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a><br>) -&gt; impl <a class="trait" href="../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>&lt;Item = <a class="struct" href="../tantivy/struct.SegmentMeta.html" title="struct tantivy::SegmentMeta">SegmentMeta</a>, Error = <a class="struct" href="../futures/sync/oneshot/struct.Canceled.html" title="struct futures::sync::oneshot::Canceled">Canceled</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tantivy/indexer/index_writer.rs.html#447-452' title='goto source code'>[src]</a></span></h4>
</div><h4 id='method.merge' class="method"><span id='merge.v' class='invisible'><code>pub fn <a href='#method.merge' class='fnname'>merge</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;segment_ids: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;[</a><a class="struct" href="../tantivy/struct.SegmentId.html" title="struct tantivy::SegmentId">SegmentId</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a><br>) -&gt; impl <a class="trait" href="../futures/future/trait.Future.html" title="trait futures::future::Future">Future</a>&lt;Item = <a class="struct" href="../tantivy/struct.SegmentMeta.html" title="struct tantivy::SegmentMeta">SegmentMeta</a>, Error = <a class="struct" href="../futures/sync/oneshot/struct.Canceled.html" title="struct futures::sync::oneshot::Canceled">Canceled</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tantivy/indexer/index_writer.rs.html#451-456' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Merges a given list of segments</p>
</div><h4 id='method.rollback' class="method"><span id='rollback.v' class='invisible'><code>pub fn <a href='#method.rollback' class='fnname'>rollback</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../tantivy/struct.Error.html" title="struct tantivy::Error">Error</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tantivy/indexer/index_writer.rs.html#480-515' title='goto source code'>[src]</a></span></h4>
</div><h4 id='method.rollback' class="method"><span id='rollback.v' class='invisible'><code>pub fn <a href='#method.rollback' class='fnname'>rollback</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../tantivy/struct.Error.html" title="struct tantivy::Error">Error</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tantivy/indexer/index_writer.rs.html#484-519' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Rollback to the last commit</p>
<p>This cancels all of the update that
happened before after the last commit.
After calling rollback, the index is in the same
state as it was after the last commit.</p>
<p>The opstamp at the last commit is returned.</p>
</div><h4 id='method.prepare_commit' class="method"><span id='prepare_commit.v' class='invisible'><code>pub fn <a href='#method.prepare_commit' class='fnname'>prepare_commit</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;PreparedCommit, <a class="struct" href="../tantivy/struct.Error.html" title="struct tantivy::Error">Error</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tantivy/indexer/index_writer.rs.html#538-575' title='goto source code'>[src]</a></span></h4>
</div><h4 id='method.prepare_commit' class="method"><span id='prepare_commit.v' class='invisible'><code>pub fn <a href='#method.prepare_commit' class='fnname'>prepare_commit</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;PreparedCommit, <a class="struct" href="../tantivy/struct.Error.html" title="struct tantivy::Error">Error</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tantivy/indexer/index_writer.rs.html#542-579' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Prepares a commit.</p>
<p>Calling <code>prepare_commit()</code> will cut the indexing
queue. All pending documents will be sent to the
@@ -108,7 +113,7 @@ dropped.</p>
<p>It is also possible to add a payload to the <code>commit</code>
using this API.
See <a href="PreparedCommit.html"><code>PreparedCommit::set_payload()</code></a></p>
</div><h4 id='method.commit' class="method"><span id='commit.v' class='invisible'><code>pub fn <a href='#method.commit' class='fnname'>commit</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>, <a class="struct" href="../tantivy/struct.Error.html" title="struct tantivy::Error">Error</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tantivy/indexer/index_writer.rs.html#591-593' title='goto source code'>[src]</a></span></h4>
</div><h4 id='method.commit' class="method"><span id='commit.v' class='invisible'><code>pub fn <a href='#method.commit' class='fnname'>commit</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>, <a class="struct" href="../tantivy/struct.Error.html" title="struct tantivy::Error">Error</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tantivy/indexer/index_writer.rs.html#595-597' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Commits all of the pending changes</p>
<p>A call to commit blocks.
After it returns, all of the document that
@@ -119,20 +124,20 @@ long as the hard disk is spared), it will be possible
to resume indexing from this point.</p>
<p>Commit returns the <code>opstamp</code> of the last document
that made it in the commit.</p>
</div><h4 id='method.delete_term' class="method"><span id='delete_term.v' class='invisible'><code>pub fn <a href='#method.delete_term' class='fnname'>delete_term</a>(&amp;mut self, term: <a class="struct" href="../tantivy/struct.Term.html" title="struct tantivy::Term">Term</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tantivy/indexer/index_writer.rs.html#607-612' title='goto source code'>[src]</a></span></h4>
</div><h4 id='method.delete_term' class="method"><span id='delete_term.v' class='invisible'><code>pub fn <a href='#method.delete_term' class='fnname'>delete_term</a>(&amp;mut self, term: <a class="struct" href="../tantivy/struct.Term.html" title="struct tantivy::Term">Term</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tantivy/indexer/index_writer.rs.html#611-616' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Delete all documents containing a given term.</p>
<p>Delete operation only affects documents that
were added in previous commits, and documents
that were added previously in the same commit.</p>
<p>Like adds, the deletion itself will be visible
only after calling <code>commit()</code>.</p>
</div><h4 id='method.commit_opstamp' class="method"><span id='commit_opstamp.v' class='invisible'><code>pub fn <a href='#method.commit_opstamp' class='fnname'>commit_opstamp</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tantivy/indexer/index_writer.rs.html#621-623' title='goto source code'>[src]</a></span></h4>
</div><h4 id='method.commit_opstamp' class="method"><span id='commit_opstamp.v' class='invisible'><code>pub fn <a href='#method.commit_opstamp' class='fnname'>commit_opstamp</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tantivy/indexer/index_writer.rs.html#625-627' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns the opstamp of the last successful commit.</p>
<p>This is, for instance, the opstamp the index will
rollback to if there is a failure like a power surge.</p>
<p>This is also the opstamp of the commit that is currently
available for searchers.</p>
</div><h4 id='method.add_document' class="method"><span id='add_document.v' class='invisible'><code>pub fn <a href='#method.add_document' class='fnname'>add_document</a>(&amp;mut self, document: <a class="struct" href="../tantivy/struct.Document.html" title="struct tantivy::Document">Document</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tantivy/indexer/index_writer.rs.html#635-640' title='goto source code'>[src]</a></span></h4>
</div><h4 id='method.add_document' class="method"><span id='add_document.v' class='invisible'><code>pub fn <a href='#method.add_document' class='fnname'>add_document</a>(&amp;mut self, document: <a class="struct" href="../tantivy/struct.Document.html" title="struct tantivy::Document">Document</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tantivy/indexer/index_writer.rs.html#639-644' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Adds a document.</p>
<p>If the indexing pipeline is full, this call may block.</p>
<p>The opstamp is an increasing <code>u64</code> that can