mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-01-06 21:32:58 +00:00
30 lines
13 KiB
HTML
30 lines
13 KiB
HTML
<!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="Trait for vector index engines (HNSW implementations)."><title>VectorIndexEngine in store_api::storage - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-e56847b5.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="store_api" data-themes="" data-resource-suffix="" data-rustdoc-version="1.92.0-nightly (fa3155a64 2025-09-30)" data-channel="nightly" data-search-js="search-e256b49e.js" data-stringdex-js="stringdex-828709d0.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-ce535bd0.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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]--><rustdoc-topbar><h2><a href="#">VectorIndexEngine</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../store_api/index.html">store_<wbr>api</a><span class="version">1.0.0-beta.4</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Vector<wbr>Index<wbr>Engine</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.add" title="add">add</a></li><li><a href="#tymethod.capacity" title="capacity">capacity</a></li><li><a href="#tymethod.memory_usage" title="memory_usage">memory_usage</a></li><li><a href="#tymethod.reserve" title="reserve">reserve</a></li><li><a href="#tymethod.save_to_buffer" title="save_to_buffer">save_to_buffer</a></li><li><a href="#tymethod.search" title="search">search</a></li><li><a href="#tymethod.serialized_length" title="serialized_length">serialized_length</a></li><li><a href="#tymethod.size" title="size">size</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In store_<wbr>api::<wbr>storage</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">store_api</a>::<wbr><a href="index.html">storage</a></div><h1>Trait <span class="trait">Vector<wbr>Index<wbr>Engine</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/store_api/storage/requests.rs.html#52-76">Source</a> </span></div><pre class="rust item-decl"><code>pub trait VectorIndexEngine: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> {
|
|
// Required methods
|
|
fn <a href="#tymethod.add" class="fn">add</a>(&mut self, key: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>, vector: &[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a>]) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, BoxedError>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.search" class="fn">search</a>(
|
|
&self,
|
|
query: &[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a>],
|
|
k: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.VectorSearchMatches.html" title="struct store_api::storage::VectorSearchMatches">VectorSearchMatches</a>, BoxedError>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.serialized_length" class="fn">serialized_length</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.save_to_buffer" class="fn">save_to_buffer</a>(&self, buffer: &mut [<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>]) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, BoxedError>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.reserve" class="fn">reserve</a>(&mut self, capacity: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, BoxedError>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.size" class="fn">size</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.capacity" class="fn">capacity</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.memory_usage" class="fn">memory_usage</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>;
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Trait for vector index engines (HNSW implementations).</p>
|
|
<p>This trait defines the interface for pluggable vector index engines.
|
|
Implementations (e.g., UsearchEngine) are provided by storage engines like mito2.</p>
|
|
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.add" class="method"><a class="src rightside" href="../../src/store_api/storage/requests.rs.html#54">Source</a><h4 class="code-header">fn <a href="#tymethod.add" class="fn">add</a>(&mut self, key: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>, vector: &[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a>]) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, BoxedError></h4></section></summary><div class="docblock"><p>Adds a vector with the given key.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.search" class="method"><a class="src rightside" href="../../src/store_api/storage/requests.rs.html#57">Source</a><h4 class="code-header">fn <a href="#tymethod.search" class="fn">search</a>(
|
|
&self,
|
|
query: &[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a>],
|
|
k: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.VectorSearchMatches.html" title="struct store_api::storage::VectorSearchMatches">VectorSearchMatches</a>, BoxedError></h4></section></summary><div class="docblock"><p>Searches for k nearest neighbors.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.serialized_length" class="method"><a class="src rightside" href="../../src/store_api/storage/requests.rs.html#60">Source</a><h4 class="code-header">fn <a href="#tymethod.serialized_length" class="fn">serialized_length</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns the serialized length.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.save_to_buffer" class="method"><a class="src rightside" href="../../src/store_api/storage/requests.rs.html#63">Source</a><h4 class="code-header">fn <a href="#tymethod.save_to_buffer" class="fn">save_to_buffer</a>(&self, buffer: &mut [<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>]) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, BoxedError></h4></section></summary><div class="docblock"><p>Serializes the index to a buffer.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.reserve" class="method"><a class="src rightside" href="../../src/store_api/storage/requests.rs.html#66">Source</a><h4 class="code-header">fn <a href="#tymethod.reserve" class="fn">reserve</a>(&mut self, capacity: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, BoxedError></h4></section></summary><div class="docblock"><p>Reserves capacity for vectors.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.size" class="method"><a class="src rightside" href="../../src/store_api/storage/requests.rs.html#69">Source</a><h4 class="code-header">fn <a href="#tymethod.size" class="fn">size</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns current size (number of vectors).</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.capacity" class="method"><a class="src rightside" href="../../src/store_api/storage/requests.rs.html#72">Source</a><h4 class="code-header">fn <a href="#tymethod.capacity" class="fn">capacity</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns current capacity.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.memory_usage" class="method"><a class="src rightside" href="../../src/store_api/storage/requests.rs.html#75">Source</a><h4 class="code-header">fn <a href="#tymethod.memory_usage" class="fn">memory_usage</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns memory usage in bytes.</p>
|
|
</div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../../trait.impl/store_api/storage/requests/trait.VectorIndexEngine.js" async></script></section></div></main></body></html> |