itsscb/heapless
1
0
Fork 0
mirror of https://github.com/rust-embedded/heapless.git synced 2025-10-02 14:54:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

deploy: b107f928b6ec0ffc966bf526a57c954e6042c057

Browse Source
This commit is contained in:
korken89 2021-02-08 08:00:54 +00:00
parent cdd605e37b
commit 4954c1e109
7 changed files with 87 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
heapless/all.html
View File

File diff suppressed because one or more lines are too long

2
heapless/index.html
View File

@ -1,6 +1,6 @@
<!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 `heapless` crate."><meta name="keywords" content="rust, rustlang, rust-lang, heapless"><title>heapless - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg"> <!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 `heapless` crate."><meta name="keywords" content="rust, rustlang, rust-lang, heapless"><title>heapless - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png"> <link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../heapless/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Crate heapless</p><div class="block version"><p>Version 0.5.6</p></div><div class="sidebar-elems"><a id="all-types" href="all.html"><p>See all heapless's items</p></a><div class="block items"><ul><li><a href="#reexports">Re-exports</a></li><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class="location"></p><script>window.sidebarCurrent = {name: "heapless", ty: "mod", relpath: "../"};</script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><span class="help-button">?</span> <link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../heapless/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Crate heapless</p><div class="block version"><p>Version 0.6.0</p></div><div class="sidebar-elems"><a id="all-types" href="all.html"><p>See all heapless's items</p></a><div class="block items"><ul><li><a href="#reexports">Re-exports</a></li><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class="location"></p><script>window.sidebarCurrent = {name: "heapless", ty: "mod", relpath: "../"};</script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><span class="help-button">?</span>
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span><a class="srclink" href="../src/heapless/lib.rs.html#1-113" title="goto source code">[src]</a></span><span class="in-band">Crate <a class="mod" href="">heapless</a></span></h1><div class="docblock"><p><code>static</code> friendly data structures that don't require dynamic memory allocation</p> <a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span><a class="srclink" href="../src/heapless/lib.rs.html#1-113" title="goto source code">[src]</a></span><span class="in-band">Crate <a class="mod" href="">heapless</a></span></h1><div class="docblock"><p><code>static</code> friendly data structures that don't require dynamic memory allocation</p>
<p>The core principle behind <code>heapless</code> is that its data structures are backed by a <em>static</em> memory <p>The core principle behind <code>heapless</code> is that its data structures are backed by a <em>static</em> memory
allocation. For example, you can think of <code>heapless::Vec</code> as an alternative version of allocation. For example, you can think of <code>heapless::Vec</code> as an alternative version of

2
heapless/pool/singleton/index.html
View File

@ -1,7 +1,7 @@
<!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 `singleton` mod in crate `heapless`."><meta name="keywords" content="rust, rustlang, rust-lang, singleton"><title>heapless::pool::singleton - Rust</title><link rel="stylesheet" type="text/css" href="../../../normalize.css"><link rel="stylesheet" type="text/css" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../../ayu.css" disabled ><script id="default-settings"></script><script src="../../../storage.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../../favicon.svg"> <!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 `singleton` mod in crate `heapless`."><meta name="keywords" content="rust, rustlang, rust-lang, singleton"><title>heapless::pool::singleton - Rust</title><link rel="stylesheet" type="text/css" href="../../../normalize.css"><link rel="stylesheet" type="text/css" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../../ayu.css" disabled ><script id="default-settings"></script><script src="../../../storage.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../../favicon.svg">
<link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png"> <link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png">
<link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../../../heapless/index.html'><div class='logo-container rust-logo'><img src='../../../rust-logo.png' alt='logo'></div></a><p class="location">Module singleton</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li></ul></div><p class="location"><a href="../../index.html">heapless</a>::<wbr><a href="../index.html">pool</a></p><script>window.sidebarCurrent = {name: "singleton", ty: "mod", relpath: "../"};</script><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><span class="help-button">?</span> <link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../../../heapless/index.html'><div class='logo-container rust-logo'><img src='../../../rust-logo.png' alt='logo'></div></a><p class="location">Module singleton</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li></ul></div><p class="location"><a href="../../index.html">heapless</a>::<wbr><a href="../index.html">pool</a></p><script>window.sidebarCurrent = {name: "singleton", ty: "mod", relpath: "../"};</script><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><span class="help-button">?</span>
<a id="settings-menu" href="../../../settings.html"><img src="../../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span><a class="srclink" href="../../../src/heapless/pool/singleton.rs.html#1-364" title="goto source code">[src]</a></span><span class="in-band">Module <a href="../../index.html">heapless</a>::<wbr><a href="../index.html">pool</a>::<wbr><a class="mod" href="">singleton</a></span></h1><div class="docblock"><p><code>Pool</code> as a global singleton</p> <a id="settings-menu" href="../../../settings.html"><img src="../../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span><a class="srclink" href="../../../src/heapless/pool/singleton.rs.html#1-394" title="goto source code">[src]</a></span><span class="in-band">Module <a href="../../index.html">heapless</a>::<wbr><a href="../index.html">pool</a>::<wbr><a class="mod" href="">singleton</a></span></h1><div class="docblock"><p><code>Pool</code> as a global singleton</p>
</div><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2> </div><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
<table><tr class="module-item"><td><a class="struct" href="struct.Box.html" title="heapless::pool::singleton::Box struct">Box</a></td><td class="docblock-short"><p>A memory block that belongs to the global memory pool, <code>POOL</code></p> <table><tr class="module-item"><td><a class="struct" href="struct.Box.html" title="heapless::pool::singleton::Box struct">Box</a></td><td class="docblock-short"><p>A memory block that belongs to the global memory pool, <code>POOL</code></p>
</td></tr></table><h2 id="traits" class="section-header"><a href="#traits">Traits</a></h2> </td></tr></table><h2 id="traits" class="section-header"><a href="#traits">Traits</a></h2>

33
heapless/pool/singleton/struct.Box.html
View File

File diff suppressed because one or more lines are too long

4
heapless/trait.ArrayLength.html
View File

@ -1,8 +1,8 @@
<!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 `ArrayLength` trait in crate `heapless`."><meta name="keywords" content="rust, rustlang, rust-lang, ArrayLength"><title>heapless::ArrayLength - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg"> <!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 `ArrayLength` trait in crate `heapless`."><meta name="keywords" content="rust, rustlang, rust-lang, ArrayLength"><title>heapless::ArrayLength - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png"> <link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../heapless/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Trait ArrayLength</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-types">Associated Types</a><div class="sidebar-links"><a href="#associatedtype.ArrayType">ArrayType</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-ArrayLength%3CT%3E-for-UInt%3CN%2C%20B0%3E">UInt&lt;N, B0&gt;</a><a href="#impl-ArrayLength%3CT%3E-for-UInt%3CN%2C%20B1%3E">UInt&lt;N, B1&gt;</a><a href="#impl-ArrayLength%3CT%3E-for-UTerm">UTerm</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class="location"><a href="index.html">heapless</a></p><script>window.sidebarCurrent = {name: "ArrayLength", ty: "trait", relpath: ""};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><span class="help-button">?</span> <link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../heapless/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Trait ArrayLength</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-types">Associated Types</a><div class="sidebar-links"><a href="#associatedtype.ArrayType">ArrayType</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-ArrayLength%3CT%3E-for-UInt%3CN%2C%20B0%3E">UInt&lt;N, B0&gt;</a><a href="#impl-ArrayLength%3CT%3E-for-UInt%3CN%2C%20B1%3E">UInt&lt;N, B1&gt;</a><a href="#impl-ArrayLength%3CT%3E-for-UTerm">UTerm</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class="location"><a href="index.html">heapless</a></p><script>window.sidebarCurrent = {name: "ArrayLength", ty: "trait", relpath: ""};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><span class="help-button">?</span>
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span><a class="srclink" href="../src/generic_array/lib.rs.html#75-78" title="goto source code">[src]</a></span><span class="in-band">Trait <a href="index.html">heapless</a>::<wbr><a class="trait" href="">ArrayLength</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub unsafe trait ArrayLength&lt;T&gt;: <a class="trait" href="../typenum/marker_traits/trait.Unsigned.html" title="trait typenum::marker_traits::Unsigned">Unsigned</a> { <a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span><a class="srclink" href="../src/generic_array/lib.rs.html#105-108" title="goto source code">[src]</a></span><span class="in-band">Trait <a href="index.html">heapless</a>::<wbr><a class="trait" href="">ArrayLength</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub unsafe trait ArrayLength&lt;T&gt;: <a class="trait" href="../typenum/marker_traits/trait.Unsigned.html" title="trait typenum::marker_traits::Unsigned">Unsigned</a> {
type <a href="#associatedtype.ArrayType" class="type">ArrayType</a>; type <a href="#associatedtype.ArrayType" class="type">ArrayType</a>;
}</pre></div><div class="docblock"><p>Trait making <code>GenericArray</code> work, marking types to be used as length of an array</p> }</pre></div><div class="docblock"><p>Trait making <code>GenericArray</code> work, marking types to be used as length of an array</p>
</div><h2 id="associated-types" class="small-section-header">Associated Types<a href="#associated-types" class="anchor"></a></h2><div class="methods"><h3 id="associatedtype.ArrayType" class="method"><code>type <a href="#associatedtype.ArrayType" class="type">ArrayType</a></code></h3><div class="docblock"><p>Associated type representing the array type for the number</p> </div><h2 id="associated-types" class="small-section-header">Associated Types<a href="#associated-types" class="anchor"></a></h2><div class="methods"><h3 id="associatedtype.ArrayType" class="method"><code>type <a href="#associatedtype.ArrayType" class="type">ArrayType</a></code></h3><div class="docblock"><p>Associated type representing the array type for the number</p>
</div></div><span class="loading-content">Loading content...</span><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><h3 id="impl-ArrayLength%3CT%3E-for-UTerm" class="impl"><code class="in-band">impl&lt;T&gt; <a class="trait" href="../heapless/trait.ArrayLength.html" title="trait heapless::ArrayLength">ArrayLength</a>&lt;T&gt; for <a class="struct" href="../typenum/uint/struct.UTerm.html" title="struct typenum::uint::UTerm">UTerm</a></code><a href="#impl-ArrayLength%3CT%3E-for-UTerm" class="anchor"></a><a class="srclink" href="../src/generic_array/lib.rs.html#80-83" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-ArrayLength%3CT%3E-for-UInt%3CN%2C%20B1%3E" class="impl"><code class="in-band">impl&lt;T, N&gt; <a class="trait" href="../heapless/trait.ArrayLength.html" title="trait heapless::ArrayLength">ArrayLength</a>&lt;T&gt; for <a class="struct" href="../typenum/uint/struct.UInt.html" title="struct typenum::uint::UInt">UInt</a>&lt;N, <a class="struct" href="../heapless/consts/struct.B1.html" title="struct heapless::consts::B1">B1</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;N: <a class="trait" href="../heapless/trait.ArrayLength.html" title="trait heapless::ArrayLength">ArrayLength</a>&lt;T&gt;,&nbsp;</span></code><a href="#impl-ArrayLength%3CT%3E-for-UInt%3CN%2C%20B1%3E" class="anchor"></a><a class="srclink" href="../src/generic_array/lib.rs.html#134-137" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-ArrayLength%3CT%3E-for-UInt%3CN%2C%20B0%3E" class="impl"><code class="in-band">impl&lt;T, N&gt; <a class="trait" href="../heapless/trait.ArrayLength.html" title="trait heapless::ArrayLength">ArrayLength</a>&lt;T&gt; for <a class="struct" href="../typenum/uint/struct.UInt.html" title="struct typenum::uint::UInt">UInt</a>&lt;N, <a class="struct" href="../heapless/consts/struct.B0.html" title="struct heapless::consts::B0">B0</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;N: <a class="trait" href="../heapless/trait.ArrayLength.html" title="trait heapless::ArrayLength">ArrayLength</a>&lt;T&gt;,&nbsp;</span></code><a href="#impl-ArrayLength%3CT%3E-for-UInt%3CN%2C%20B0%3E" class="anchor"></a><a class="srclink" href="../src/generic_array/lib.rs.html#129-132" title="goto source code">[src]</a></h3><div class="impl-items"></div><span class="loading-content">Loading content...</span><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../implementors/generic_array/trait.ArrayLength.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "heapless";</script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> </div></div><span class="loading-content">Loading content...</span><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><h3 id="impl-ArrayLength%3CT%3E-for-UInt%3CN%2C%20B0%3E" class="impl"><code class="in-band">impl&lt;T, N&gt; <a class="trait" href="../heapless/trait.ArrayLength.html" title="trait heapless::ArrayLength">ArrayLength</a>&lt;T&gt; for <a class="struct" href="../typenum/uint/struct.UInt.html" title="struct typenum::uint::UInt">UInt</a>&lt;N, <a class="struct" href="../heapless/consts/struct.B0.html" title="struct heapless::consts::B0">B0</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;N: <a class="trait" href="../heapless/trait.ArrayLength.html" title="trait heapless::ArrayLength">ArrayLength</a>&lt;T&gt;,&nbsp;</span></code><a href="#impl-ArrayLength%3CT%3E-for-UInt%3CN%2C%20B0%3E" class="anchor"></a><a class="srclink" href="../src/generic_array/lib.rs.html#159-162" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-ArrayLength%3CT%3E-for-UInt%3CN%2C%20B1%3E" class="impl"><code class="in-band">impl&lt;T, N&gt; <a class="trait" href="../heapless/trait.ArrayLength.html" title="trait heapless::ArrayLength">ArrayLength</a>&lt;T&gt; for <a class="struct" href="../typenum/uint/struct.UInt.html" title="struct typenum::uint::UInt">UInt</a>&lt;N, <a class="struct" href="../heapless/consts/struct.B1.html" title="struct heapless::consts::B1">B1</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;N: <a class="trait" href="../heapless/trait.ArrayLength.html" title="trait heapless::ArrayLength">ArrayLength</a>&lt;T&gt;,&nbsp;</span></code><a href="#impl-ArrayLength%3CT%3E-for-UInt%3CN%2C%20B1%3E" class="anchor"></a><a class="srclink" href="../src/generic_array/lib.rs.html#164-167" title="goto source code">[src]</a></h3><div class="impl-items"></div><h3 id="impl-ArrayLength%3CT%3E-for-UTerm" class="impl"><code class="in-band">impl&lt;T&gt; <a class="trait" href="../heapless/trait.ArrayLength.html" title="trait heapless::ArrayLength">ArrayLength</a>&lt;T&gt; for <a class="struct" href="../typenum/uint/struct.UTerm.html" title="struct typenum::uint::UTerm">UTerm</a></code><a href="#impl-ArrayLength%3CT%3E-for-UTerm" class="anchor"></a><a class="srclink" href="../src/generic_array/lib.rs.html#110-113" title="goto source code">[src]</a></h3><div class="impl-items"></div><span class="loading-content">Loading content...</span><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../implementors/generic_array/trait.ArrayLength.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "heapless";</script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>

2
search-index.js
View File

File diff suppressed because one or more lines are too long

66
src/heapless/pool/singleton.rs.html
View File

@ -365,6 +365,36 @@
<span id="362">362</span> <span id="362">362</span>
<span id="363">363</span> <span id="363">363</span>
<span id="364">364</span> <span id="364">364</span>
<span id="365">365</span>
<span id="366">366</span>
<span id="367">367</span>
<span id="368">368</span>
<span id="369">369</span>
<span id="370">370</span>
<span id="371">371</span>
<span id="372">372</span>
<span id="373">373</span>
<span id="374">374</span>
<span id="375">375</span>
<span id="376">376</span>
<span id="377">377</span>
<span id="378">378</span>
<span id="379">379</span>
<span id="380">380</span>
<span id="381">381</span>
<span id="382">382</span>
<span id="383">383</span>
<span id="384">384</span>
<span id="385">385</span>
<span id="386">386</span>
<span id="387">387</span>
<span id="388">388</span>
<span id="389">389</span>
<span id="390">390</span>
<span id="391">391</span>
<span id="392">392</span>
<span id="393">393</span>
<span id="394">394</span>
</pre><div class="example-wrap"><pre class="rust "> </pre><div class="example-wrap"><pre class="rust ">
<span class="doccomment">//! `Pool` as a global singleton</span> <span class="doccomment">//! `Pool` as a global singleton</span>
@ -514,6 +544,30 @@
} }
} }
<span class="kw">impl</span><span class="op">&lt;</span><span class="ident">P</span><span class="op">&gt;</span> <span class="ident">Box</span><span class="op">&lt;</span><span class="ident">P</span>, <span class="ident">Init</span><span class="op">&gt;</span>
<span class="kw">where</span>
<span class="ident">P</span>: <span class="ident">Pool</span>,
{
<span class="doccomment">/// Forgets the contents of this memory block without running its destructor.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Note that this this does not return the memory block to the pool. The</span>
<span class="doccomment">/// block can be reused, or returned to the pool by dropping it.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">forget</span>(<span class="self">self</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="ident">Box</span><span class="op">&lt;</span><span class="ident">P</span>, <span class="ident">Uninit</span><span class="op">&gt;</span> {
<span class="kw">let</span> <span class="ident">node</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">node</span>;
<span class="ident">mem</span>::<span class="ident">forget</span>(<span class="self">self</span>);
<span class="ident">mem</span>::<span class="ident">forget</span>(<span class="kw">unsafe</span> { <span class="ident">ptr</span>::<span class="ident">read</span>(<span class="ident">node</span>.<span class="ident">as_ref</span>().<span class="ident">data</span>.<span class="ident">get</span>()) });
<span class="ident">Box</span> {
<span class="ident">inner</span>: <span class="kw">super</span>::<span class="ident">Box</span> {
<span class="ident">node</span>,
<span class="ident">_state</span>: <span class="ident">PhantomData</span>,
},
<span class="ident">_pool</span>: <span class="ident">PhantomData</span>,
}
}
}
<span class="kw">impl</span><span class="op">&lt;</span><span class="ident">P</span><span class="op">&gt;</span> <span class="ident">Deref</span> <span class="kw">for</span> <span class="ident">Box</span><span class="op">&lt;</span><span class="ident">P</span><span class="op">&gt;</span> <span class="kw">impl</span><span class="op">&lt;</span><span class="ident">P</span><span class="op">&gt;</span> <span class="ident">Deref</span> <span class="kw">for</span> <span class="ident">Box</span><span class="op">&lt;</span><span class="ident">P</span><span class="op">&gt;</span>
<span class="kw">where</span> <span class="kw">where</span>
<span class="ident">P</span>: <span class="ident">Pool</span>, <span class="ident">P</span>: <span class="ident">Pool</span>,
@ -716,18 +770,24 @@
<span class="kw">let</span> <span class="ident">x</span> <span class="op">=</span> <span class="ident">A</span>::<span class="ident">alloc</span>().<span class="ident">unwrap</span>().<span class="ident">init</span>(<span class="ident">X</span>::<span class="ident">new</span>()); <span class="kw">let</span> <span class="ident">x</span> <span class="op">=</span> <span class="ident">A</span>::<span class="ident">alloc</span>().<span class="ident">unwrap</span>().<span class="ident">init</span>(<span class="ident">X</span>::<span class="ident">new</span>());
<span class="kw">let</span> <span class="ident">y</span> <span class="op">=</span> <span class="ident">A</span>::<span class="ident">alloc</span>().<span class="ident">unwrap</span>().<span class="ident">init</span>(<span class="ident">X</span>::<span class="ident">new</span>()); <span class="kw">let</span> <span class="ident">y</span> <span class="op">=</span> <span class="ident">A</span>::<span class="ident">alloc</span>().<span class="ident">unwrap</span>().<span class="ident">init</span>(<span class="ident">X</span>::<span class="ident">new</span>());
<span class="kw">let</span> <span class="ident">z</span> <span class="op">=</span> <span class="ident">A</span>::<span class="ident">alloc</span>().<span class="ident">unwrap</span>().<span class="ident">init</span>(<span class="ident">X</span>::<span class="ident">new</span>());
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">COUNT</span>.<span class="ident">load</span>(<span class="ident">Ordering</span>::<span class="ident">Relaxed</span>), <span class="number">2</span>); <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">COUNT</span>.<span class="ident">load</span>(<span class="ident">Ordering</span>::<span class="ident">Relaxed</span>), <span class="number">3</span>);
<span class="comment">// this runs `X`&#39;s destructor</span> <span class="comment">// this runs `X`&#39;s destructor</span>
<span class="ident">drop</span>(<span class="ident">x</span>); <span class="ident">drop</span>(<span class="ident">x</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">COUNT</span>.<span class="ident">load</span>(<span class="ident">Ordering</span>::<span class="ident">Relaxed</span>), <span class="number">1</span>); <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">COUNT</span>.<span class="ident">load</span>(<span class="ident">Ordering</span>::<span class="ident">Relaxed</span>), <span class="number">2</span>);
<span class="comment">// this leaks memory</span> <span class="comment">// this leaks memory</span>
<span class="ident">mem</span>::<span class="ident">forget</span>(<span class="ident">y</span>); <span class="ident">mem</span>::<span class="ident">forget</span>(<span class="ident">y</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">COUNT</span>.<span class="ident">load</span>(<span class="ident">Ordering</span>::<span class="ident">Relaxed</span>), <span class="number">1</span>); <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">COUNT</span>.<span class="ident">load</span>(<span class="ident">Ordering</span>::<span class="ident">Relaxed</span>), <span class="number">2</span>);
<span class="comment">// this forgets `X` without leaking memory</span>
<span class="ident">z</span>.<span class="ident">forget</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">COUNT</span>.<span class="ident">load</span>(<span class="ident">Ordering</span>::<span class="ident">Relaxed</span>), <span class="number">2</span>);
} }
} }
</pre></div> </pre></div>