23 lines
10 KiB
HTML
23 lines
10 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="API documentation for the Rust `StoreMut` trait in crate `litemap`."><title>StoreMut in 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 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="#">StoreMut</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="#">Store<wbr>Mut</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.lm_clear" title="lm_clear">lm_clear</a></li><li><a href="#tymethod.lm_get_mut" title="lm_get_mut">lm_get_mut</a></li><li><a href="#tymethod.lm_insert" title="lm_insert">lm_insert</a></li><li><a href="#tymethod.lm_push" title="lm_push">lm_push</a></li><li><a href="#tymethod.lm_remove" title="lm_remove">lm_remove</a></li><li><a href="#tymethod.lm_reserve" title="lm_reserve">lm_reserve</a></li><li><a href="#tymethod.lm_with_capacity" title="lm_with_capacity">lm_with_capacity</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In litemap::<wbr>store</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>::<wbr><a href="index.html">store</a></div><h1>Trait <span class="trait">Store<wbr>Mut</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#86-119">Source</a> </span></div><pre class="rust item-decl"><code>pub trait StoreMut<K, V>: <a class="trait" href="trait.Store.html" title="trait litemap::store::Store">Store</a><K, V> {
|
|
// Required methods
|
|
fn <a href="#tymethod.lm_with_capacity" class="fn">lm_with_capacity</a>(capacity: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a>) -> Self;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.lm_reserve" class="fn">lm_reserve</a>(&mut self, additional: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a>);
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.lm_get_mut" class="fn">lm_get_mut</a>(&mut self, index: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><(<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&K</a>, <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&mut V</a>)>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.lm_push" class="fn">lm_push</a>(&mut self, key: K, value: V);
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.lm_insert" class="fn">lm_insert</a>(&mut self, index: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a>, key: K, value: V);
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.lm_remove" class="fn">lm_remove</a>(&mut self, index: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.tuple.html">(K, V)</a>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.lm_clear" class="fn">lm_clear</a>(&mut self);
|
|
}</code></pre><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.lm_with_capacity" class="method"><a class="src rightside" href="../../src/litemap/store/mod.rs.html#90">Source</a><h4 class="code-header">fn <a href="#tymethod.lm_with_capacity" class="fn">lm_with_capacity</a>(capacity: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a>) -> Self</h4></section></summary><div class="docblock"><p>Creates a new store with the specified capacity hint.</p>
|
|
<p>Implementations may ignore the argument if they do not support pre-allocating capacity.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.lm_reserve" class="method"><a class="src rightside" href="../../src/litemap/store/mod.rs.html#95">Source</a><h4 class="code-header">fn <a href="#tymethod.lm_reserve" class="fn">lm_reserve</a>(&mut self, additional: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a>)</h4></section></summary><div class="docblock"><p>Reserves additional capacity in the store.</p>
|
|
<p>Implementations may ignore the argument if they do not support pre-allocating capacity.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.lm_get_mut" class="method"><a class="src rightside" href="../../src/litemap/store/mod.rs.html#98">Source</a><h4 class="code-header">fn <a href="#tymethod.lm_get_mut" class="fn">lm_get_mut</a>(&mut self, index: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><(<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&K</a>, <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&mut V</a>)></h4></section></summary><div class="docblock"><p>Gets a key/value pair at the specified index, with a mutable value.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.lm_push" class="method"><a class="src rightside" href="../../src/litemap/store/mod.rs.html#101">Source</a><h4 class="code-header">fn <a href="#tymethod.lm_push" class="fn">lm_push</a>(&mut self, key: K, value: V)</h4></section></summary><div class="docblock"><p>Pushes one additional item onto the store.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.lm_insert" class="method"><a class="src rightside" href="../../src/litemap/store/mod.rs.html#108">Source</a><h4 class="code-header">fn <a href="#tymethod.lm_insert" class="fn">lm_insert</a>(&mut self, index: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a>, key: K, value: V)</h4></section></summary><div class="docblock"><p>Inserts an item at a specific index in the store.</p>
|
|
<h5 id="panics"><a class="doc-anchor" href="#panics">§</a>Panics</h5>
|
|
<p>Panics if <code>index</code> is greater than the length.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.lm_remove" class="method"><a class="src rightside" href="../../src/litemap/store/mod.rs.html#115">Source</a><h4 class="code-header">fn <a href="#tymethod.lm_remove" class="fn">lm_remove</a>(&mut self, index: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.tuple.html">(K, V)</a></h4></section></summary><div class="docblock"><p>Removes an item at a specific index in the store.</p>
|
|
<h5 id="panics-1"><a class="doc-anchor" href="#panics-1">§</a>Panics</h5>
|
|
<p>Panics if <code>index</code> is greater than the length.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.lm_clear" class="method"><a class="src rightside" href="../../src/litemap/store/mod.rs.html#118">Source</a><h4 class="code-header">fn <a href="#tymethod.lm_clear" class="fn">lm_clear</a>(&mut self)</h4></section></summary><div class="docblock"><p>Removes all items from the store.</p>
|
|
</div></details></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.93.1/reference/items/traits.html#dyn-compatibility">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../../trait.impl/litemap/store/trait.StoreMut.js" async></script></section></div></main></body></html> |