|
|
<!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="Signal a memory allocation error."><title>handle_alloc_error in 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 fn"><!--[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><div class="sidebar-elems"><h2><a href="index.html">In allocator_api2::alloc</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>Function <a href="../index.html">allocator_api2</a>::<wbr><a href="index.html">alloc</a>::<wbr><a class="fn" href="#">handle_alloc_error</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"><span class="since" title="Stable since Rust version 1.28.0, const unstable">1.28.0 (const: <a href="https://github.com/rust-lang/rust/issues/92523" title="Tracking issue for const_alloc_error">unstable</a>)</span> · <a class="src" href="https://doc.rust-lang.org/1.76.0/src/alloc/alloc.rs.html#375">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub fn handle_alloc_error(layout: <a class="struct" href="struct.Layout.html" title="struct allocator_api2::alloc::Layout">Layout</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.never.html">!</a></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Signal a memory allocation error.</p>
|
|
|
<p>Callers of memory allocation APIs wishing to cease execution
|
|
|
in response to an allocation error are encouraged to call this function,
|
|
|
rather than directly invoking <a href="https://doc.rust-lang.org/1.76.0/core/macro.panic.html" title="macro core::panic"><code>panic!</code></a> or similar.</p>
|
|
|
<p>This function is guaranteed to diverge (not return normally with a value), but depending on
|
|
|
global configuration, it may either panic (resulting in unwinding or aborting as per
|
|
|
configuration for all panics), or abort the process (with no unwinding).</p>
|
|
|
<p>The default behavior is:</p>
|
|
|
<ul>
|
|
|
<li>
|
|
|
<p>If the binary links against <code>std</code> (typically the case), then
|
|
|
print a message to standard error and abort the process.
|
|
|
This behavior can be replaced with <a href="../../std/alloc/fn.set_alloc_error_hook.html"><code>set_alloc_error_hook</code></a> and <a href="../../std/alloc/fn.take_alloc_error_hook.html"><code>take_alloc_error_hook</code></a>.
|
|
|
Future versions of Rust may panic by default instead.</p>
|
|
|
</li>
|
|
|
<li>
|
|
|
<p>If the binary does not link against <code>std</code> (all of its crates are marked
|
|
|
<a href="https://doc.rust-lang.org/reference/names/preludes.html#the-no_std-attribute"><code>#![no_std]</code></a>), then call <a href="https://doc.rust-lang.org/1.76.0/core/macro.panic.html" title="macro core::panic"><code>panic!</code></a> with a message.
|
|
|
<a href="https://doc.rust-lang.org/reference/runtime.html#the-panic_handler-attribute">The panic handler</a> applies as to any panic.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</div></details></section></div></main></body></html> |