239 lines
No EOL
13 KiB
HTML
239 lines
No EOL
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="Source of the Rust file `/home/zenn/.cargo/registry/src/index.crates.io-6f17d22bba15001f/heapless-0.7.16/src/lib.rs`."><title>lib.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Bold-a2c9cd1067f8b328.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-cb6f1f67f1bcd037.css" id="mainThemeStyle"><meta name="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 (500647fd8 2023-07-27)" 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" ><script src="../../static.files/storage-db41da1a38ea3cb8.js"></script><script defer src="../../static.files/src-script-3280b574d94e47b4.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-0795b7d26be81095.js"></script><noscript><link rel="stylesheet" media="(prefers-color-scheme:light)" href="../../static.files/light-6d2c9675f3d09c26.css"><link rel="stylesheet" media="(prefers-color-scheme:dark)" href="../../static.files/dark-45ceb8f2e522f4d1.css"><link rel="stylesheet" href="../../static.files/noscript-cffde32267a19fd6.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"></nav><main><nav class="sub"><a class="sub-logo-container" href="../../heapless/index.html"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><form class="search-form"><span></span><input class="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"><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="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><div data-nosnippet><pre class="src-line-numbers"><a href="#1" id="1">1</a>
|
||
<a href="#2" id="2">2</a>
|
||
<a href="#3" id="3">3</a>
|
||
<a href="#4" id="4">4</a>
|
||
<a href="#5" id="5">5</a>
|
||
<a href="#6" id="6">6</a>
|
||
<a href="#7" id="7">7</a>
|
||
<a href="#8" id="8">8</a>
|
||
<a href="#9" id="9">9</a>
|
||
<a href="#10" id="10">10</a>
|
||
<a href="#11" id="11">11</a>
|
||
<a href="#12" id="12">12</a>
|
||
<a href="#13" id="13">13</a>
|
||
<a href="#14" id="14">14</a>
|
||
<a href="#15" id="15">15</a>
|
||
<a href="#16" id="16">16</a>
|
||
<a href="#17" id="17">17</a>
|
||
<a href="#18" id="18">18</a>
|
||
<a href="#19" id="19">19</a>
|
||
<a href="#20" id="20">20</a>
|
||
<a href="#21" id="21">21</a>
|
||
<a href="#22" id="22">22</a>
|
||
<a href="#23" id="23">23</a>
|
||
<a href="#24" id="24">24</a>
|
||
<a href="#25" id="25">25</a>
|
||
<a href="#26" id="26">26</a>
|
||
<a href="#27" id="27">27</a>
|
||
<a href="#28" id="28">28</a>
|
||
<a href="#29" id="29">29</a>
|
||
<a href="#30" id="30">30</a>
|
||
<a href="#31" id="31">31</a>
|
||
<a href="#32" id="32">32</a>
|
||
<a href="#33" id="33">33</a>
|
||
<a href="#34" id="34">34</a>
|
||
<a href="#35" id="35">35</a>
|
||
<a href="#36" id="36">36</a>
|
||
<a href="#37" id="37">37</a>
|
||
<a href="#38" id="38">38</a>
|
||
<a href="#39" id="39">39</a>
|
||
<a href="#40" id="40">40</a>
|
||
<a href="#41" id="41">41</a>
|
||
<a href="#42" id="42">42</a>
|
||
<a href="#43" id="43">43</a>
|
||
<a href="#44" id="44">44</a>
|
||
<a href="#45" id="45">45</a>
|
||
<a href="#46" id="46">46</a>
|
||
<a href="#47" id="47">47</a>
|
||
<a href="#48" id="48">48</a>
|
||
<a href="#49" id="49">49</a>
|
||
<a href="#50" id="50">50</a>
|
||
<a href="#51" id="51">51</a>
|
||
<a href="#52" id="52">52</a>
|
||
<a href="#53" id="53">53</a>
|
||
<a href="#54" id="54">54</a>
|
||
<a href="#55" id="55">55</a>
|
||
<a href="#56" id="56">56</a>
|
||
<a href="#57" id="57">57</a>
|
||
<a href="#58" id="58">58</a>
|
||
<a href="#59" id="59">59</a>
|
||
<a href="#60" id="60">60</a>
|
||
<a href="#61" id="61">61</a>
|
||
<a href="#62" id="62">62</a>
|
||
<a href="#63" id="63">63</a>
|
||
<a href="#64" id="64">64</a>
|
||
<a href="#65" id="65">65</a>
|
||
<a href="#66" id="66">66</a>
|
||
<a href="#67" id="67">67</a>
|
||
<a href="#68" id="68">68</a>
|
||
<a href="#69" id="69">69</a>
|
||
<a href="#70" id="70">70</a>
|
||
<a href="#71" id="71">71</a>
|
||
<a href="#72" id="72">72</a>
|
||
<a href="#73" id="73">73</a>
|
||
<a href="#74" id="74">74</a>
|
||
<a href="#75" id="75">75</a>
|
||
<a href="#76" id="76">76</a>
|
||
<a href="#77" id="77">77</a>
|
||
<a href="#78" id="78">78</a>
|
||
<a href="#79" id="79">79</a>
|
||
<a href="#80" id="80">80</a>
|
||
<a href="#81" id="81">81</a>
|
||
<a href="#82" id="82">82</a>
|
||
<a href="#83" id="83">83</a>
|
||
<a href="#84" id="84">84</a>
|
||
<a href="#85" id="85">85</a>
|
||
<a href="#86" id="86">86</a>
|
||
<a href="#87" id="87">87</a>
|
||
<a href="#88" id="88">88</a>
|
||
<a href="#89" id="89">89</a>
|
||
<a href="#90" id="90">90</a>
|
||
<a href="#91" id="91">91</a>
|
||
<a href="#92" id="92">92</a>
|
||
<a href="#93" id="93">93</a>
|
||
<a href="#94" id="94">94</a>
|
||
<a href="#95" id="95">95</a>
|
||
<a href="#96" id="96">96</a>
|
||
<a href="#97" id="97">97</a>
|
||
<a href="#98" id="98">98</a>
|
||
<a href="#99" id="99">99</a>
|
||
<a href="#100" id="100">100</a>
|
||
<a href="#101" id="101">101</a>
|
||
<a href="#102" id="102">102</a>
|
||
<a href="#103" id="103">103</a>
|
||
<a href="#104" id="104">104</a>
|
||
<a href="#105" id="105">105</a>
|
||
<a href="#106" id="106">106</a>
|
||
<a href="#107" id="107">107</a>
|
||
<a href="#108" id="108">108</a>
|
||
<a href="#109" id="109">109</a>
|
||
<a href="#110" id="110">110</a>
|
||
<a href="#111" id="111">111</a>
|
||
<a href="#112" id="112">112</a>
|
||
<a href="#113" id="113">113</a>
|
||
<a href="#114" id="114">114</a>
|
||
<a href="#115" id="115">115</a>
|
||
<a href="#116" id="116">116</a>
|
||
<a href="#117" id="117">117</a>
|
||
<a href="#118" id="118">118</a>
|
||
<a href="#119" id="119">119</a>
|
||
</pre></div><pre class="rust"><code><span class="doccomment">//! `static` friendly data structures that don't require dynamic memory allocation
|
||
//!
|
||
//! The core principle behind `heapless` is that its data structures are backed by a *static* memory
|
||
//! allocation. For example, you can think of `heapless::Vec` as an alternative version of
|
||
//! `std::Vec` with fixed capacity and that can't be re-allocated on the fly (e.g. via `push`).
|
||
//!
|
||
//! All `heapless` data structures store their memory allocation *inline* and specify their capacity
|
||
//! via their type parameter `N`. This means that you can instantiate a `heapless` data structure on
|
||
//! the stack, in a `static` variable, or even in the heap.
|
||
//!
|
||
//! ```
|
||
//! use heapless::Vec; // fixed capacity `std::Vec`
|
||
//!
|
||
//! // on the stack
|
||
//! let mut xs: Vec<u8, 8> = Vec::new(); // can hold up to 8 elements
|
||
//! xs.push(42).unwrap();
|
||
//! assert_eq!(xs.pop(), Some(42));
|
||
//!
|
||
//! // in a `static` variable
|
||
//! static mut XS: Vec<u8, 8> = Vec::new();
|
||
//!
|
||
//! let xs = unsafe { &mut XS };
|
||
//!
|
||
//! xs.push(42);
|
||
//! assert_eq!(xs.pop(), Some(42));
|
||
//!
|
||
//! // in the heap (though kind of pointless because no reallocation)
|
||
//! let mut ys: Box<Vec<u8, 8>> = Box::new(Vec::new());
|
||
//! ys.push(42).unwrap();
|
||
//! assert_eq!(ys.pop(), Some(42));
|
||
//! ```
|
||
//!
|
||
//! Because they have fixed capacity `heapless` data structures don't implicitly reallocate. This
|
||
//! means that operations like `heapless::Vec.push` are *truly* constant time rather than amortized
|
||
//! constant time with potentially unbounded (depends on the allocator) worst case execution time
|
||
//! (which is bad / unacceptable for hard real time applications).
|
||
//!
|
||
//! `heapless` data structures don't use a memory allocator which means no risk of an uncatchable
|
||
//! Out Of Memory (OOM) condition while performing operations on them. It's certainly possible to
|
||
//! run out of capacity while growing `heapless` data structures, but the API lets you handle this
|
||
//! possibility by returning a `Result` on operations that may exhaust the capacity of the data
|
||
//! structure.
|
||
//!
|
||
//! List of currently implemented data structures:
|
||
//!
|
||
//! - [`Arc`](pool/singleton/arc/struct.Arc.html) -- Thread-safe reference-counting pointer backed by a memory pool
|
||
//! - [`BinaryHeap`](binary_heap/struct.BinaryHeap.html) -- priority queue
|
||
//! - [`IndexMap`](struct.IndexMap.html) -- hash table
|
||
//! - [`IndexSet`](struct.IndexSet.html) -- hash set
|
||
//! - [`LinearMap`](struct.LinearMap.html)
|
||
//! - [`Pool`](pool/struct.Pool.html) -- lock-free memory pool
|
||
//! - [`String`](struct.String.html)
|
||
//! - [`Vec`](struct.Vec.html)
|
||
//! - [`mpmc::Q*`](mpmc/index.html) -- multiple producer multiple consumer lock-free queue
|
||
//! - [`spsc::Queue`](spsc/struct.Queue.html) -- single producer single consumer lock-free queue
|
||
//!
|
||
//! # Optional Features
|
||
//!
|
||
//! The `heapless` crate provides the following optional Cargo features:
|
||
//!
|
||
//! - `ufmt-impl`: Implement [`ufmt_write::uWrite`] for `String<N>` and `Vec<u8, N>`
|
||
//!
|
||
//! [`ufmt_write::uWrite`]: https://docs.rs/ufmt-write/
|
||
//!
|
||
//! # Minimum Supported Rust Version (MSRV)
|
||
//!
|
||
//! This crate is guaranteed to compile on stable Rust 1.51 and up with its default set of features.
|
||
//! It *might* compile on older versions but that may change in any new patch release.
|
||
|
||
</span><span class="attr">#![cfg_attr(not(test), no_std)]
|
||
#![deny(missing_docs)]
|
||
#![deny(rust_2018_compatibility)]
|
||
#![deny(rust_2018_idioms)]
|
||
#![deny(warnings)]
|
||
#![deny(const_err)]
|
||
|
||
</span><span class="kw">pub use </span>binary_heap::BinaryHeap;
|
||
<span class="kw">pub use </span>deque::Deque;
|
||
<span class="kw">pub use </span>histbuf::{HistoryBuffer, OldestOrdered};
|
||
<span class="kw">pub use </span>indexmap::{Bucket, Entry, FnvIndexMap, IndexMap, OccupiedEntry, Pos, VacantEntry};
|
||
<span class="kw">pub use </span>indexset::{FnvIndexSet, IndexSet};
|
||
<span class="kw">pub use </span>linear_map::LinearMap;
|
||
<span class="attr">#[cfg(all(has_cas, feature = <span class="string">"cas"</span>))]
|
||
</span><span class="kw">pub use </span>pool::singleton::arc::Arc;
|
||
<span class="kw">pub use </span>string::String;
|
||
<span class="kw">pub use </span>vec::Vec;
|
||
|
||
<span class="attr">#[macro_use]
|
||
#[cfg(test)]
|
||
</span><span class="kw">mod </span>test_helpers;
|
||
|
||
<span class="kw">mod </span>deque;
|
||
<span class="kw">mod </span>histbuf;
|
||
<span class="kw">mod </span>indexmap;
|
||
<span class="kw">mod </span>indexset;
|
||
<span class="kw">mod </span>linear_map;
|
||
<span class="kw">mod </span>string;
|
||
<span class="kw">mod </span>vec;
|
||
|
||
<span class="attr">#[cfg(feature = <span class="string">"serde"</span>)]
|
||
</span><span class="kw">mod </span>de;
|
||
<span class="attr">#[cfg(feature = <span class="string">"serde"</span>)]
|
||
</span><span class="kw">mod </span>ser;
|
||
|
||
<span class="kw">pub mod </span>binary_heap;
|
||
<span class="attr">#[cfg(feature = <span class="string">"defmt-impl"</span>)]
|
||
</span><span class="kw">mod </span>defmt;
|
||
<span class="attr">#[cfg(all(has_cas, feature = <span class="string">"cas"</span>))]
|
||
</span><span class="kw">pub mod </span>mpmc;
|
||
<span class="attr">#[cfg(all(has_cas, feature = <span class="string">"cas"</span>))]
|
||
</span><span class="kw">pub mod </span>pool;
|
||
<span class="kw">pub mod </span>sorted_linked_list;
|
||
<span class="attr">#[cfg(has_atomics)]
|
||
</span><span class="kw">pub mod </span>spsc;
|
||
|
||
<span class="attr">#[cfg(feature = <span class="string">"ufmt-impl"</span>)]
|
||
</span><span class="kw">mod </span>ufmt;
|
||
|
||
<span class="kw">mod </span>sealed;
|
||
</code></pre></div></section></main></body></html> |