|
|
<!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="Memory allocation APIs"><title>allocator_api2::alloc - Rust</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/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="allocator_api2" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-feafe1bb7466e4bd.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 mod"><!--[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">☰</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../allocator_api2/index.html">allocator_api2</a><span class="version">0.2.16</span></h2></div><h2 class="location"><a href="#">Module alloc</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></section><h2><a href="../index.html">In crate allocator_api2</a></h2></div></nav><div class="sidebar-resizer"></div>
|
|
|
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../allocator_api2/all.html" title="show sidebar"></a></div><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" tabindex="-1"><a href="../../help.html" title="help">?</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="main-heading"><h1>Module <a href="../index.html">allocator_api2</a>::<wbr><a class="mod" href="#">alloc</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/allocator_api2/stable/alloc/mod.rs.html#1-416">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Memory allocation APIs</p>
|
|
|
</div></details><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.AllocError.html" title="struct allocator_api2::alloc::AllocError">AllocError</a></div><div class="desc docblock-short">The <code>AllocError</code> error indicates an allocation failure
|
|
|
that may be due to resource exhaustion or to
|
|
|
something wrong when combining the given input arguments with this
|
|
|
allocator.</div></li><li><div class="item-name"><a class="struct" href="struct.Global.html" title="struct allocator_api2::alloc::Global">Global</a></div><div class="desc docblock-short">The global memory allocator.</div></li><li><div class="item-name"><a class="struct" href="struct.Layout.html" title="struct allocator_api2::alloc::Layout">Layout</a></div><div class="desc docblock-short">Layout of a block of memory.</div></li><li><div class="item-name"><a class="struct" href="struct.LayoutError.html" title="struct allocator_api2::alloc::LayoutError">LayoutError</a></div><div class="desc docblock-short">The parameters given to <code>Layout::from_size_align</code>
|
|
|
or some other <code>Layout</code> constructor
|
|
|
do not satisfy its documented constraints.</div></li></ul><h2 id="traits" class="section-header"><a href="#traits">Traits</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.Allocator.html" title="trait allocator_api2::alloc::Allocator">Allocator</a></div><div class="desc docblock-short">An implementation of <code>Allocator</code> can allocate, grow, shrink, and deallocate arbitrary blocks of
|
|
|
data described via <a href="struct.Layout.html" title="struct allocator_api2::alloc::Layout"><code>Layout</code></a>.</div></li><li><div class="item-name"><a class="trait" href="trait.GlobalAlloc.html" title="trait allocator_api2::alloc::GlobalAlloc">GlobalAlloc</a></div><div class="desc docblock-short">A memory allocator that can be registered as the standard library’s default
|
|
|
through the <code>#[global_allocator]</code> attribute.</div></li></ul><h2 id="functions" class="section-header"><a href="#functions">Functions</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.alloc.html" title="fn allocator_api2::alloc::alloc">alloc</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Allocate memory with the global allocator.</div></li><li><div class="item-name"><a class="fn" href="fn.alloc_zeroed.html" title="fn allocator_api2::alloc::alloc_zeroed">alloc_zeroed</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Allocate zero-initialized memory with the global allocator.</div></li><li><div class="item-name"><a class="fn" href="fn.dealloc.html" title="fn allocator_api2::alloc::dealloc">dealloc</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Deallocate memory with the global allocator.</div></li><li><div class="item-name"><a class="fn" href="fn.handle_alloc_error.html" title="fn allocator_api2::alloc::handle_alloc_error">handle_alloc_error</a></div><div class="desc docblock-short">Signal a memory allocation error.</div></li><li><div class="item-name"><a class="fn" href="fn.realloc.html" title="fn allocator_api2::alloc::realloc">realloc</a><sup title="unsafe function">⚠</sup></div><div class="desc docblock-short">Reallocate memory with the global allocator.</div></li></ul></section></div></main></body></html> |