| <!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="`Column` provides columnar access on a field."><meta name="keywords" content="rust, rustlang, rust-lang, Column"><title>Column in tantivy::fastfield - 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="#">Column</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.get_val">get_val</a></li><li><a href="#tymethod.max_value">max_value</a></li><li><a href="#tymethod.min_value">min_value</a></li><li><a href="#tymethod.num_vals">num_vals</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.get_docids_for_value_range">get_docids_for_value_range</a></li><li><a href="#method.get_range">get_range</a></li><li><a href="#method.iter">iter</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-Column%3CT%3E-for-%26%27a%20C">&'a C</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In tantivy::fastfield</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 href="index.html">fastfield</a>::<wbr><a class="trait" href="#">Column</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/fastfield_codecs/column.rs.html#10">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 Column<T = u64>: Send + Sync<span class="where fmt-newline">where<br> T: PartialOrd<T> + Debug,</span>{ |
| fn <a href="#tymethod.get_val" class="fnname">get_val</a>(&self, idx: u32) -> T; |
| <span class="item-spacer"></span> fn <a href="#tymethod.min_value" class="fnname">min_value</a>(&self) -> T; |
| <span class="item-spacer"></span> fn <a href="#tymethod.max_value" class="fnname">max_value</a>(&self) -> T; |
| <span class="item-spacer"></span> fn <a href="#tymethod.num_vals" class="fnname">num_vals</a>(&self) -> u32; |
| |
| fn <a href="#method.get_range" class="fnname">get_range</a>(&self, start: u64, output: &mut [T]) { ... } |
| <span class="item-spacer"></span> fn <a href="#method.get_docids_for_value_range" class="fnname">get_docids_for_value_range</a>(<br> &self,<br> value_range: RangeInclusive<T>,<br> doc_id_range: Range<u32>,<br> positions: &mut Vec<u32, Global><br> ) { ... } |
| <span class="item-spacer"></span> fn <a href="#method.iter" class="fnname">iter</a>(&'a self) -> Box<dyn Iterator<Item = T> + 'a, Global> { ... } |
| }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>Column</code> provides columnar access on a field.</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.get_val" class="method has-srclink"><a class="srclink rightside" href="../../src/fastfield_codecs/column.rs.html#18">source</a><h4 class="code-header">fn <a href="#tymethod.get_val" class="fnname">get_val</a>(&self, idx: u32) -> T</h4></section></summary><div class="docblock"><p>Return the value associated with the given idx.</p> |
| <p>This accessor should return as fast as possible.</p> |
| <h5 id="panics"><a href="#panics">Panics</a></h5> |
| <p>May panic if <code>idx</code> is greater than the column length.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.min_value" class="method has-srclink"><a class="srclink rightside" href="../../src/fastfield_codecs/column.rs.html#61">source</a><h4 class="code-header">fn <a href="#tymethod.min_value" class="fnname">min_value</a>(&self) -> T</h4></section></summary><div class="docblock"><p>Returns the minimum value for this fast field.</p> |
| <p>This min_value may not be exact. |
| For instance, the min value does not take in account of possible |
| deleted document. All values are however guaranteed to be higher than |
| <code>.min_value()</code>.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.max_value" class="method has-srclink"><a class="srclink rightside" href="../../src/fastfield_codecs/column.rs.html#69">source</a><h4 class="code-header">fn <a href="#tymethod.max_value" class="fnname">max_value</a>(&self) -> T</h4></section></summary><div class="docblock"><p>Returns the maximum value for this fast field.</p> |
| <p>This max_value may not be exact. |
| For instance, the max value does not take in account of possible |
| deleted document. All values are however guaranteed to be higher than |
| <code>.max_value()</code>.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.num_vals" class="method has-srclink"><a class="srclink rightside" href="../../src/fastfield_codecs/column.rs.html#72">source</a><h4 class="code-header">fn <a href="#tymethod.num_vals" class="fnname">num_vals</a>(&self) -> u32</h4></section></summary><div class="docblock"><p>The number of values in the column.</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.get_range" class="method has-srclink"><a class="srclink rightside" href="../../src/fastfield_codecs/column.rs.html#29">source</a><h4 class="code-header">fn <a href="#method.get_range" class="fnname">get_range</a>(&self, start: u64, output: &mut [T])</h4></section></summary><div class="docblock"><p>Fills an output buffer with the fast field values |
| associated with the <code>DocId</code> going from |
| <code>start</code> to <code>start + output.len()</code>.</p> |
| <h5 id="panics-1"><a href="#panics-1">Panics</a></h5> |
| <p>Must panic if <code>start + output.len()</code> is greater than |
| the segment’s <code>maxdoc</code>.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.get_docids_for_value_range" class="method has-srclink"><a class="srclink rightside" href="../../src/fastfield_codecs/column.rs.html#39-44">source</a><h4 class="code-header">fn <a href="#method.get_docids_for_value_range" class="fnname">get_docids_for_value_range</a>(<br> &self,<br> value_range: RangeInclusive<T>,<br> doc_id_range: Range<u32>,<br> positions: &mut Vec<u32, Global><br>)</h4></section></summary><div class="docblock"><p>Get the positions of values which are in the provided value range.</p> |
| <p>Note that position == docid for single value fast fields</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.iter" class="method has-srclink"><a class="srclink rightside" href="../../src/fastfield_codecs/column.rs.html#75">source</a><h4 class="code-header">fn <a href="#method.iter" class="fnname">iter</a>(&'a self) -> Box<dyn Iterator<Item = T> + 'a, Global></h4></section></summary><div class="docblock"><p>Returns a iterator over the data</p> |
| </div></details></div><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Column%3CT%3E-for-%26%27a%20C" class="impl has-srclink"><a class="srclink rightside" href="../../src/fastfield_codecs/column.rs.html#87">source</a><a href="#impl-Column%3CT%3E-for-%26%27a%20C" class="anchor"></a><h3 class="code-header">impl<'a, C, T> <a class="trait" href="trait.Column.html" title="trait tantivy::fastfield::Column">Column</a><T> for &'a C<span class="where fmt-newline">where<br> C: <a class="trait" href="trait.Column.html" title="trait tantivy::fastfield::Column">Column</a><T>,<br> T: Copy + PartialOrd<T> + Debug,</span></h3></section></summary><div class="impl-items"><section id="method.get_val" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/fastfield_codecs/column.rs.html#88">source</a><a href="#method.get_val" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.get_val" class="fnname">get_val</a>(&self, idx: u32) -> T</h4></section><section id="method.min_value" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/fastfield_codecs/column.rs.html#92">source</a><a href="#method.min_value" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.min_value" class="fnname">min_value</a>(&self) -> T</h4></section><section id="method.max_value" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/fastfield_codecs/column.rs.html#96">source</a><a href="#method.max_value" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.max_value" class="fnname">max_value</a>(&self) -> T</h4></section><section id="method.num_vals" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/fastfield_codecs/column.rs.html#100">source</a><a href="#method.num_vals" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.num_vals" class="fnname">num_vals</a>(&self) -> u32</h4></section><section id="method.iter-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/fastfield_codecs/column.rs.html#104">source</a><a href="#method.iter-1" class="anchor"></a><h4 class="code-header">fn <a href="#method.iter" class="fnname">iter</a>(&'b self) -> Box<dyn Iterator<Item = T> + 'b, Global></h4></section><section id="method.get_range-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/fastfield_codecs/column.rs.html#108">source</a><a href="#method.get_range-1" class="anchor"></a><h4 class="code-header">fn <a href="#method.get_range" class="fnname">get_range</a>(&self, start: u64, output: &mut [T])</h4></section></div></details><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"><section id="impl-Column%3CT%3E-for-VecColumn%3C%27a%2C%20T%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/fastfield_codecs/column.rs.html#113">source</a><a href="#impl-Column%3CT%3E-for-VecColumn%3C%27a%2C%20T%3E" class="anchor"></a><h3 class="code-header">impl<'a, T> <a class="trait" href="trait.Column.html" title="trait tantivy::fastfield::Column">Column</a><T> for <a class="struct" href="../../fastfield_codecs/column/struct.VecColumn.html" title="struct fastfield_codecs::column::VecColumn">VecColumn</a><'a, T><span class="where fmt-newline">where<br> T: Copy + PartialOrd<T> + Send + Sync + Debug,</span></h3></section><section id="impl-Column%3C%3CT%20as%20Iterator%3E%3A%3AItem%3E-for-IterColumn%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/fastfield_codecs/column.rs.html#258">source</a><a href="#impl-Column%3C%3CT%20as%20Iterator%3E%3A%3AItem%3E-for-IterColumn%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="trait.Column.html" title="trait tantivy::fastfield::Column">Column</a><<T as Iterator>::Item> for <a class="struct" href="../../fastfield_codecs/column/struct.IterColumn.html" title="struct fastfield_codecs::column::IterColumn">IterColumn</a><T><span class="where fmt-newline">where<br> T: Iterator + Clone + ExactSizeIterator + Send + Sync,<br> <T as Iterator>::Item: PartialOrd<<T as Iterator>::Item> + Debug,</span></h3></section></div><script src="../../implementors/fastfield_codecs/column/trait.Column.js" data-ignore-extern-crates="fastfield_codecs" 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> |
