std::alloc::set_alloc_error_hook - Rust
Description: API documentation for the Rust `set_alloc_error_hook` fn in crate `std`.
Keywords: rust, rustlang, rust-lang, set_alloc_error_hook

# [−][src]Function std::alloc::set_alloc_error_hook

    pub fn set_alloc_error_hook(hook: fn(_: Layout))

🔬 This is a nightly-only experimental API. (`alloc_error_hook` #51245)

Registers a custom allocation error hook, replacing any that was previously registered.

The allocation error hook is invoked when an infallible memory allocation fails, before the runtime aborts. The default hook prints a message to standard error, but this behavior can be customized with the `set_alloc_error_hook` and `take_alloc_error_hook` functions.

The hook is provided with a `Layout` struct which contains information about the allocation that failed.

The allocation error hook is a global resource.

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g., `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g., `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g., `str,u8` or `String,struct:Vec,test`)