mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-12-26 20:09:33 +01:00
23 lines
No EOL
9.7 KiB
HTML
23 lines
No EOL
9.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="A global singleton memory pool"><title>Pool in heapless::pool::singleton - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../static.files/rustdoc-b0742ba02757f159.css"><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.83.0 (90b35a623 2024-11-26)" data-channel="1.83.0" data-search-js="search-f0d225181b97f9a4.js" data-settings-js="settings-805db61a62df4bd2.js" ><script src="../../../static.files/storage-1d39b6787ed640ff.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../static.files/main-f070b9041d14864c.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-0111fcff984fae8f.css"></noscript><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 trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../heapless/index.html">heapless</a><span class="version">0.7.17</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Pool</a></h2><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Data" title="Data">Data</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.alloc" title="alloc">alloc</a></li><li><a href="#method.grow" title="grow">grow</a></li><li><a href="#method.grow_exact" title="grow_exact">grow_exact</a></li></ul><h3><a href="#object-safety">Object Safety</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In heapless::<wbr>pool::<wbr>singleton</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../../index.html">heapless</a>::<wbr><a href="../index.html">pool</a>::<wbr><a href="index.html">singleton</a></span><h1>Trait <span class="trait">Pool</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/heapless/pool/singleton.rs.html#50-91">source</a> </span></div><pre class="rust item-decl"><code>pub trait Pool {
|
|
type <a href="#associatedtype.Data" class="associatedtype">Data</a>: 'static;
|
|
|
|
// Provided methods
|
|
fn <a href="#method.alloc" class="fn">alloc</a>() -> <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="struct.Box.html" title="struct heapless::pool::singleton::Box">Box</a><Self, <a class="enum" href="../enum.Uninit.html" title="enum heapless::pool::Uninit">Uninit</a>>>
|
|
<span class="where">where Self: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></span> { ... }
|
|
<span class="item-spacer"></span> fn <a href="#method.grow" class="fn">grow</a>(memory: &'static mut [<a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.u8.html">u8</a>]) -> <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.usize.html">usize</a> { ... }
|
|
<span class="item-spacer"></span> fn <a href="#method.grow_exact" class="fn">grow_exact</a><A>(memory: &'static mut <a class="union" href="https://doc.rust-lang.org/1.83.0/core/mem/maybe_uninit/union.MaybeUninit.html" title="union core::mem::maybe_uninit::MaybeUninit">MaybeUninit</a><A>) -> <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.usize.html">usize</a>
|
|
<span class="where">where A: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.AsMut.html" title="trait core::convert::AsMut">AsMut</a><[<a class="struct" href="../struct.Node.html" title="struct heapless::pool::Node">Node</a><Self::<a class="associatedtype" href="trait.Pool.html#associatedtype.Data" title="type heapless::pool::singleton::Pool::Data">Data</a>>]></span> { ... }
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A global singleton memory pool</p>
|
|
</div></details><h2 id="required-associated-types" class="section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><details class="toggle" open><summary><section id="associatedtype.Data" class="method"><a class="src rightside" href="../../../src/heapless/pool/singleton.rs.html#52">source</a><h4 class="code-header">type <a href="#associatedtype.Data" class="associatedtype">Data</a>: 'static</h4></section></summary><div class="docblock"><p>The type of data that can be allocated on this pool</p>
|
|
</div></details></div><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.alloc" class="method"><a class="src rightside" href="../../../src/heapless/pool/singleton.rs.html#62-70">source</a><h4 class="code-header">fn <a href="#method.alloc" class="fn">alloc</a>() -> <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="struct.Box.html" title="struct heapless::pool::singleton::Box">Box</a><Self, <a class="enum" href="../enum.Uninit.html" title="enum heapless::pool::Uninit">Uninit</a>>><div class="where">where
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class="docblock"><p>Claims a memory block from the pool</p>
|
|
<p>Returns <code>None</code> when the pool is observed as exhausted</p>
|
|
<p><em>NOTE:</em> This method does <em>not</em> have bounded execution time; i.e. it contains a CAS loop</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.grow" class="method"><a class="src rightside" href="../../../src/heapless/pool/singleton.rs.html#77-79">source</a><h4 class="code-header">fn <a href="#method.grow" class="fn">grow</a>(memory: &'static mut [<a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.u8.html">u8</a>]) -> <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Increases the capacity of the pool</p>
|
|
<p>This method might <em>not</em> fully utilize the given memory block due to alignment requirements</p>
|
|
<p>This method returns the number of <em>new</em> blocks that can be allocated.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.grow_exact" class="method"><a class="src rightside" href="../../../src/heapless/pool/singleton.rs.html#85-90">source</a><h4 class="code-header">fn <a href="#method.grow_exact" class="fn">grow_exact</a><A>(memory: &'static mut <a class="union" href="https://doc.rust-lang.org/1.83.0/core/mem/maybe_uninit/union.MaybeUninit.html" title="union core::mem::maybe_uninit::MaybeUninit">MaybeUninit</a><A>) -> <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.usize.html">usize</a><div class="where">where
|
|
A: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.AsMut.html" title="trait core::convert::AsMut">AsMut</a><[<a class="struct" href="../struct.Node.html" title="struct heapless::pool::Node">Node</a><Self::<a class="associatedtype" href="trait.Pool.html#associatedtype.Data" title="type heapless::pool::singleton::Pool::Data">Data</a>>]>,</div></h4></section></summary><div class="docblock"><p>Increases the capacity of the pool</p>
|
|
<p>Unlike <a href="trait.Pool.html#method.grow_exact"><code>Pool.grow</code></a> this method fully utilizes the given
|
|
memory block</p>
|
|
</div></details></div><h2 id="object-safety" class="section-header">Object Safety<a href="#object-safety" class="anchor">§</a></h2><div class="object-safety-info">This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.83.0/reference/items/traits.html#object-safety">object safe</a>.</div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../../../trait.impl/heapless/pool/singleton/trait.Pool.js" async></script></section></div></main></body></html> |