<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="`static` friendly data structures that don’t require dynamic memory allocation"><title>heapless - Rust</title><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/SourceSerif4-Bold-a2c9cd1067f8b328.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><linkrel="stylesheet"href="../static.files/normalize-76eba96aa4d2e634.css"><linkrel="stylesheet"href="../static.files/rustdoc-cb6f1f67f1bcd037.css"id="mainThemeStyle"><metaname="rustdoc-vars"data-root-path="../"data-static-root-path="../static.files/"data-current-crate="heapless"data-themes=""data-resource-suffix=""data-rustdoc-version="1.73.0-nightly (8131b9774 2023-08-02)"data-channel="nightly"data-search-js="search-6dfdfced5eff6596.js"data-settings-js="settings-de11bff964e9d4e5.js"data-settings-css="settings-8c76f75bfb6bd192.css"data-theme-light-css="light-6d2c9675f3d09c26.css"data-theme-dark-css="dark-45ceb8f2e522f4d1.css"data-theme-ayu-css="ayu-fd19013d6ce078bf.css"><scriptsrc="../static.files/storage-db41da1a38ea3cb8.js"></script><scriptdefersrc="../crates.js"></script><scriptdefersrc="../static.files/main-0795b7d26be81095.js"></script><noscript><linkrel="stylesheet"media="(prefers-color-scheme:light)"href="../static.files/light-6d2c9675f3d09c26.css"><linkrel="stylesheet"media="(prefers-color-scheme:dark)"href="../static.files/dark-45ceb8f2e522f4d1.css"><linkrel="stylesheet"href="../static.files/noscript-cffde32267a19fd6.css"></noscript><linkrel="alternate icon"type="image/png"href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><linkrel="alternate icon"type="image/png"href="../static.files/favicon-32x32-422f7d1d52889060.png"><linkrel="icon"type="image/svg+xml"href="../static.files/favicon-2c020d218678b618.svg"></head><bodyclass="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="mobile-topbar"><buttonclass="sidebar-menu-toggle">☰</button><aclass="logo-container"href="../heapless/index.html"><imgclass="rust-logo"src="../static.files/rust-logo-151179464ae7ed46.svg"alt="logo"></a><h2></h2></nav><navclass="sidebar"><aclass="logo-container"href="../heapless/index.html"><imgclass="rust-logo"src="../static.files/rust-logo-151179464ae7ed46.svg"alt="logo"></a><h2class="location"><ahref="#">Crate heapless</a></h2><divclass="sidebar-elems"><ulclass="block"><liclass="version">Version 0.7.16</li><li><aid="all-types"href="all.html">All Items</a></li></ul><section><ulclass="block"><li><ahref="#reexports">Re-exports</a></li><li><ahref="#modules">Modules</a></li><li><ahref="#structs">Structs</a></li><li><ahref="#enums">Enums</a></li><li><ahref="#types">Type Definitions</a></li></ul></section></div></nav><main><divclass="width-limiter"><navclass="sub"><formclass="search-form"><span></span><inputclass="search-input"name="search"aria-label="Run search in the documentation"autocomplete="off"spellcheck="false"placeholder="Click or press ‘S’ to search, ‘?’ for more options…"type="search"><divid="help-button"title="help"tabindex="-1"><ahref="../help.html">?</a></div><divid="settings-menu"tabindex="-1"><ahref="../settings.html"title="settings"><imgwidth="22"
</span><spanclass="kw">let </span><spanclass="kw-2">mut </span>xs: Vec<u8, <spanclass="number">8</span>> = Vec::new(); <spanclass="comment">// can hold up to 8 elements
<p>The <code>heapless</code> crate provides the following optional Cargo features:</p>
<ul>
<li><code>ufmt-impl</code>: Implement <ahref="https://docs.rs/ufmt-write/"><code>ufmt_write::uWrite</code></a> for <code>String<N></code> and <code>Vec<u8, N></code></li>
</ul>
<h2id="minimum-supported-rust-version-msrv"><ahref="#minimum-supported-rust-version-msrv">Minimum Supported Rust Version (MSRV)</a></h2>
<p>This crate is guaranteed to compile on stable Rust 1.51 and up with its default set of features.
It <em>might</em> compile on older versions but that may change in any new patch release.</p>
</div></details><h2id="reexports"class="small-section-header"><ahref="#reexports">Re-exports</a></h2><ulclass="item-table"><li><divclass="item-name"id="reexport.BinaryHeap"><code>pub use binary_heap::<aclass="struct"href="binary_heap/struct.BinaryHeap.html"title="struct heapless::binary_heap::BinaryHeap">BinaryHeap</a>;</code></div></li><li><divclass="item-name"id="reexport.Bucket"><code>pub use indexmap::Bucket;</code></div></li><li><divclass="item-name"id="reexport.Pos"><code>pub use indexmap::Pos;</code></div></li></ul><h2id="modules"class="small-section-header"><ahref="#modules">Modules</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="mod"href="binary_heap/index.html"title="mod heapless::binary_heap">binary_heap</a></div><divclass="desc docblock-short">A priority queue implemented with a binary heap.</div></li><li><divclass="item-name"><aclass="mod"href="sorted_linked_list/index.html"title="mod heapless::sorted_linked_list">sorted_linked_list</a></div><divclass="desc docblock-short">A fixed sorted priority linked list, similar to <ahref="binary_heap/struct.BinaryHeap.html"title="struct heapless::binary_heap::BinaryHeap"><code>BinaryHeap</code></a> but with different properties
on <code>push</code>, <code>pop</code>, etc.
For example, the sorting of the list will never <code>memcpy</code> the underlying value, so having large
objects in the list will not cause a performance hit.</div></li></ul><h2id="structs"class="small-section-header"><ahref="#structs">Structs</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="struct"href="struct.Deque.html"title="struct heapless::Deque">Deque</a></div><divclass="desc docblock-short">A fixed capacity double-ended queue.</div></li><li><divclass="item-name"><aclass="struct"href="struct.HistoryBuffer.html"title="struct heapless::HistoryBuffer">HistoryBuffer</a></div><divclass="desc docblock-short">A “history buffer”, similar to a write-only ring buffer of fixed length.</div></li><li><divclass="item-name"><aclass="struct"href="struct.IndexMap.html"title="struct heapless::IndexMap">IndexMap</a></div><divclass="desc docblock-short">Fixed capacity <ahref="https://docs.rs/indexmap/1/indexmap/map/struct.IndexMap.html"><code>IndexMap</code></a></div></li><li><divclass="item-name"><aclass="struct"href="struct.IndexSet.html"title="struct heapless::IndexSet">IndexSet</a></div><divclass="desc docblock-short">Fixed capacity <ahref="https://docs.rs/indexmap/1/indexmap/set/struct.IndexSet.html"><code>IndexSet</code></a>.</div></li><li><divclass="item-name"><aclass="struct"href="struct.LinearMap.html"title="struct heapless::LinearMap">LinearMap</a></div><divclass="desc docblock-short">A fixed capacity map / dictionary that performs lookups via linear search</div></li><li><divclass="item-name"><aclass="struct"href="struct.OccupiedEntry.html"title="struct heapless::OccupiedEntry">OccupiedEntry</a></div><divclass="desc docblock-short">An occupied entry which can be manipulated</div></li><li><divclass="item-name"><aclass="struct"href="struct.OldestOrdered.html"title="struct heapless::OldestOrdered">OldestOrdered</a></div><divclass="desc docblock-short">An iterator on the underlying buffer ordered from oldest data to newest</div></li><li><divclass="item-name"><aclass="struct"href="struct.String.html"title="struct heapless::String">String</a></div><divclass="desc docblock-short">A fixed capacity <ahref="https://doc.rust-lang.org/std/string/struct.String.html"><code>String</code></a></div></li><li><divclass="item-name"><aclass="struct"href="struct.VacantEntry.html"title="struct heapless::VacantEntry">VacantEntry</a></div><divclass="desc docblock-short">A view into an empty slot in the underlying map</div></li><li><divclass="item-name"><aclass="struct"href="struct.Vec.html"title="struct heapless::Vec">Vec</a></div><divclass="desc docblock-short">A fixed capacity <ahref="https://doc.rust-lang.org/std/vec/struct.Vec.html"><code>Vec</code></a></div></li></ul><h2id="enums"class="small-section-header"><ahref="#enums">Enums</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="enum"href="enum.Entry.html"title="enum heapless::Entry">Entry</a></div><divclass="desc docblock-short">A view into an entry in the map</div></li></ul><h2id="types"class="small-section-header"><ahref="#types">Type Definitions</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="type"href="type.FnvIndexMap.html"title="type heapless::FnvIndexMap">FnvIndexMap</a></div><divclass="desc docblock-short">A <ahref="./struct.IndexMap.html"><code>heapless::IndexMap</code></a> using the default FNV hasher</div></li><li><divclass="item-name"><aclass="type"href="type.FnvIndexSet.html"title="type heapless::FnvIndexSet">FnvIndexSet</a></div><divclass="desc docblock-short">A <ahref="./struct.IndexSet.html"><code>heapless::IndexSet</code></a> using the
default FNV hasher.
A list of all Methods and Traits available for <code>FnvIndexSet</code> can be found in
the <ahref="./struct.IndexSet.html"><code>heapless::IndexSet</code></a> documentation.</div></li></ul></section></div></main></body></html>
