16 lines
5.7 KiB
HTML
16 lines
5.7 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="Traits for pluggable LiteMap backends."><title>litemap::store - 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-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="litemap" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.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-a410ff4d.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 mod"><!--[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="#">Module store</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../litemap/index.html">litemap</a><span class="version">0.8.1</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module store</a></h2><h3><a href="#traits">Module Items</a></h3><ul class="block"><li><a href="#traits" title="Traits">Traits</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate litemap</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">litemap</a></div><h1>Module <span>store</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/litemap/store/mod.rs.html#5-176">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Traits for pluggable LiteMap backends.</p>
|
|
<p>By default, LiteMap is backed by a <code>Vec</code>. However, in some environments, it may be desirable
|
|
to use a different data store while still using LiteMap to manage proper ordering of items.</p>
|
|
<p>The general guidelines for a performant data store are:</p>
|
|
<ol>
|
|
<li>Must support efficient random access for binary search</li>
|
|
<li>Should support efficient append operations for deserialization</li>
|
|
</ol>
|
|
<p>To plug a custom data store into LiteMap, implement:</p>
|
|
<ul>
|
|
<li><a href="trait.Store.html" title="trait litemap::store::Store"><code>Store</code></a> for most of the methods</li>
|
|
<li><a href="trait.StoreIterable.html" title="trait litemap::store::StoreIterable"><code>StoreIterable</code></a> for methods that return iterators</li>
|
|
<li><a href="trait.StoreFromIterator.html" title="trait litemap::store::StoreFromIterator"><code>StoreFromIterator</code></a> to enable <code>FromIterator</code> for LiteMap</li>
|
|
</ul>
|
|
<p>To test your implementation, enable the <code>"testing"</code> Cargo feature and use <a href="crate::testing::check_store"><code>check_store()</code></a>.</p>
|
|
</div></details><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><dl class="item-table"><dt><a class="trait" href="trait.Store.html" title="trait litemap::store::Store">Store</a></dt><dd>Trait to enable pluggable backends for LiteMap.</dd><dt><a class="trait" href="trait.StoreBulkMut.html" title="trait litemap::store::StoreBulkMut">Store<wbr>Bulk<wbr>Mut</a></dt><dt><a class="trait" href="trait.StoreConstEmpty.html" title="trait litemap::store::StoreConstEmpty">Store<wbr>Const<wbr>Empty</a></dt><dd>Trait to enable const construction of empty store.</dd><dt><a class="trait" href="trait.StoreFromIterable.html" title="trait litemap::store::StoreFromIterable">Store<wbr>From<wbr>Iterable</a></dt><dt><a class="trait" href="trait.StoreFromIterator.html" title="trait litemap::store::StoreFromIterator">Store<wbr>From<wbr>Iterator</a></dt><dd>A store that can be built from a tuple iterator.</dd><dt><a class="trait" href="trait.StoreIntoIterator.html" title="trait litemap::store::StoreIntoIterator">Store<wbr>Into<wbr>Iterator</a></dt><dt><a class="trait" href="trait.StoreIterable.html" title="trait litemap::store::StoreIterable">Store<wbr>Iterable</a></dt><dd>Iterator methods for the LiteMap store.</dd><dt><a class="trait" href="trait.StoreIterableMut.html" title="trait litemap::store::StoreIterableMut">Store<wbr>Iterable<wbr>Mut</a></dt><dt><a class="trait" href="trait.StoreMut.html" title="trait litemap::store::StoreMut">Store<wbr>Mut</a></dt><dt><a class="trait" href="trait.StoreSlice.html" title="trait litemap::store::StoreSlice">Store<wbr>Slice</a></dt></dl></section></div></main></body></html> |