| <!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="Postings (also called inverted list)"><meta name="keywords" content="rust, rustlang, rust-lang, Postings"><title>Postings in tantivy - 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">☰</button><a class="sidebar-logo" href="../tantivy/index.html"><div class="logo-container"><img src="http://fulmicoton.com/tantivy-logo/tantivy-logo.png" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../tantivy/index.html"><div class="logo-container"> |
| <img src="http://fulmicoton.com/tantivy-logo/tantivy-logo.png" alt="logo"></div></a><h2 class="location"><a href="#">Postings</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.positions_with_offset">positions_with_offset</a></li><li><a href="#tymethod.term_freq">term_freq</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.positions">positions</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In tantivy</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</a>::<wbr><a class="trait" href="#">Postings</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/postings/postings.rs.html#13-26">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 trait"><code>pub trait Postings: <a class="trait" href="trait.DocSet.html" title="trait tantivy::DocSet">DocSet</a> + 'static { |
| fn <a href="#tymethod.term_freq" class="fnname">term_freq</a>(&self) -> u32; |
| <span class="item-spacer"></span> fn <a href="#tymethod.positions_with_offset" class="fnname">positions_with_offset</a>(&mut self, offset: u32, output: &mut Vec<u32>); |
| |
| fn <a href="#method.positions" class="fnname">positions</a>(&mut self, output: &mut Vec<u32>) { ... } |
| }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Postings (also called inverted list)</p> |
| <p>For a given term, it is the list of doc ids of the doc |
| containing the term. Optionally, for each document, |
| it may also give access to the term frequency |
| as well as the list of term positions.</p> |
| <p>Its main implementation is <code>SegmentPostings</code>, |
| but other implementations mocking <code>SegmentPostings</code> exist, |
| for merging segments or for testing.</p> |
| </div></details><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.term_freq" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/postings/postings.rs.html#15">source</a><h4 class="code-header">fn <a href="#tymethod.term_freq" class="fnname">term_freq</a>(&self) -> u32</h4></section></summary><div class="docblock"><p>The number of times the term appears in the document.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.positions_with_offset" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/postings/postings.rs.html#19">source</a><h4 class="code-header">fn <a href="#tymethod.positions_with_offset" class="fnname">positions_with_offset</a>(&mut self, offset: u32, output: &mut Vec<u32>)</h4></section></summary><div class="docblock"><p>Returns the positions offsetted with a given value. |
| The output vector will be resized to the <code>term_freq</code>.</p> |
| </div></details></div><h2 id="provided-methods" class="small-section-header">Provided Methods<a href="#provided-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.positions" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy/postings/postings.rs.html#23-25">source</a><h4 class="code-header">fn <a href="#method.positions" class="fnname">positions</a>(&mut self, output: &mut Vec<u32>)</h4></section></summary><div class="docblock"><p>Returns the positions of the term in the given document. |
| The output vector will be resized to the <code>term_freq</code>.</p> |
| </div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"><section id="impl-Postings-for-SegmentPostings" class="impl has-srclink"><a class="srclink rightside" href="../src/tantivy/postings/segment_postings.rs.html#218-259">source</a><a href="#impl-Postings-for-SegmentPostings" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="postings/trait.Postings.html" title="trait tantivy::postings::Postings">Postings</a> for <a class="struct" href="postings/struct.SegmentPostings.html" title="struct tantivy::postings::SegmentPostings">SegmentPostings</a></h3></section></div><script src="../implementors/tantivy/postings/postings/trait.Postings.js" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="tantivy" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
