<!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 `FnBox` trait in crate `alloc`.">
<meta name="keywords" content="rust, rustlang, rust-lang, FnBox">
<title>alloc::boxed::FnBox - Rust</title>
<link rel="stylesheet" type="text/css" href="../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../../main.css">
<link rel="shortcut icon" href="https://doc.rust-lang.org/favicon.ico">
</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">
<a href='../../alloc/index.html'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png' alt='logo' width='100'></a>
<p class='location'>Trait FnBox</p><div class="block items"><ul><li><a href="#associated-types">Associated Types</a></li><li><a href="#required-methods">Required Methods</a></li><li><a href="#implementors">Implementors</a></li></ul></div><p class='location'><a href='../index.html'>alloc</a>::<wbr><a href='index.html'>boxed</a></p><script>window.sidebarCurrent = {name: 'FnBox', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script>
</nav>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content">
<h1 class='fqn'><span class='in-band'>Trait <a href='../index.html'>alloc</a>::<wbr><a href='index.html'>boxed</a>::<wbr><a class="trait" href=''>FnBox</a></span><span class='out-of-band'><span class='since' title='Stable since Rust version '></span><span id='render-detail'>
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
[<span class='inner'>−</span>]
</a>
</span><a class='srclink' href='../../src/alloc/boxed.rs.html#634-638' title='goto source code'>[src]</a></span></h1>
<pre class='rust trait'>pub trait FnBox<A> {
type <a href='#associatedtype.Output' class="type">Output</a>;
fn <a href='#tymethod.call_box' class='fnname'>call_box</a>(self: <a class="struct" href="../../alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>, args: A) -> Self::<a class="trait" href="../../alloc/boxed/trait.FnBox.html" title="trait alloc::boxed::FnBox">Output</a>;
}</pre><div class='stability'><div class='stab unstable'><details><summary><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>fnbox </code><a href="https://github.com/rust-lang/rust/issues/28796">#28796</a>)</summary><p>will be deprecated if and when <code>Box<FnOnce></code> becomes usable</p>
</details></div></div><div class='docblock'><p><code>FnBox</code> is a version of the <code>FnOnce</code> intended for use with boxed
closure objects. The idea is that where one would normally store a
<code>Box<FnOnce()></code> in a data structure, you should use
<code>Box<FnBox()></code>. The two traits behave essentially the same, except
that a <code>FnBox</code> closure can only be called if it is boxed. (Note
that <code>FnBox</code> may be deprecated in the future if <code>Box<FnOnce()></code>
closures become directly usable.)</p>
<h3 id='example' class='section-header'><a href='#example'>Example</a></h3>
<p>Here is a snippet of code which creates a hashmap full of boxed
once closures and then removes them one by one, calling each
closure as it is removed. Note that the type of the closures
stored in the map is <code>Box<FnBox() -> i32></code> and not <code>Box<FnOnce() -> i32></code>.</p>
<pre class="rust rust-example-rendered">
<span class="attribute">#<span class="op">!</span>[<span class="ident">feature</span>(<span class="ident">fnbox</span>)]</span>
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">boxed</span>::<span class="ident">FnBox</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">collections</span>::<span class="ident">HashMap</span>;
<span class="kw">fn</span> <span class="ident">make_map</span>() <span class="op">-></span> <span class="ident">HashMap</span><span class="op"><</span><span class="ident">i32</span>, <span class="ident">Box</span><span class="op"><</span><span class="ident">FnBox</span>() <span class="op">-></span> <span class="ident">i32</span><span class="op">>></span> {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">map</span>: <span class="ident">HashMap</span><span class="op"><</span><span class="ident">i32</span>, <span class="ident">Box</span><span class="op"><</span><span class="ident">FnBox</span>() <span class="op">-></span> <span class="ident">i32</span><span class="op">>></span> <span class="op">=</span> <span class="ident">HashMap</span>::<span class="ident">new</span>();
<span class="ident">map</span>.<span class="ident">insert</span>(<span class="number">1</span>, <span class="ident">Box</span>::<span class="ident">new</span>(<span class="op">||</span> <span class="number">22</span>));
<span class="ident">map</span>.<span class="ident">insert</span>(<span class="number">2</span>, <span class="ident">Box</span>::<span class="ident">new</span>(<span class="op">||</span> <span class="number">44</span>));
<span class="ident">map</span>
}
<span class="kw">fn</span> <span class="ident">main</span>() {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">map</span> <span class="op">=</span> <span class="ident">make_map</span>();
<span class="kw">for</span> <span class="ident">i</span> <span class="kw">in</span> <span class="kw-2">&</span>[<span class="number">1</span>, <span class="number">2</span>] {
<span class="kw">let</span> <span class="ident">f</span> <span class="op">=</span> <span class="ident">map</span>.<span class="ident">remove</span>(<span class="kw-2">&</span><span class="ident">i</span>).<span class="ident">unwrap</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">f</span>(), <span class="ident">i</span> <span class="op">*</span> <span class="number">22</span>);
}
}</pre>
</div>
<h2 id='associated-types'>Associated Types</h2>
<div class='methods'>
<h3 id='associatedtype.Output' class='method'><span id='Output.t' class='invisible'><code>type <a href='#associatedtype.Output' class="type">Output</a></code></span></h3><div class='stability'><div class='stab unstable'><details><summary><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>fnbox </code><a href="https://github.com/rust-lang/rust/issues/28796">#28796</a>)</summary><p>will be deprecated if and when <code>Box<FnOnce></code> becomes usable</p>
</details></div></div></div>
<h2 id='required-methods'>Required Methods</h2>
<div class='methods'>
<h3 id='tymethod.call_box' class='method'><span id='call_box.v' class='invisible'><code>fn <a href='#tymethod.call_box' class='fnname'>call_box</a>(self: <a class="struct" href="../../alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>, args: A) -> Self::<a class="trait" href="../../alloc/boxed/trait.FnBox.html" title="trait alloc::boxed::FnBox">Output</a></code></span></h3><div class='stability'><div class='stab unstable'><details><summary><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>fnbox </code><a href="https://github.com/rust-lang/rust/issues/28796">#28796</a>)</summary><p>will be deprecated if and when <code>Box<FnOnce></code> becomes usable</p>
</details></div></div></div>
<h2 id='implementors'>Implementors</h2>
<ul class='item-list' id='implementors-list'>
<li><code>impl<A, F> FnBox<A> for F <span class="where fmt-newline">where<br> F: <a class="trait" href="../../core/ops/trait.FnOnce.html" title="trait core::ops::FnOnce">FnOnce</a><A>, </span></code></li>
</ul><script type="text/javascript" async
src="../../implementors/alloc/boxed/trait.FnBox.js">
</script></section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>⇤</dt>
<dd>Move up in search results</dd>
<dt>⇥</dt>
<dd>Move down in search results</dd>
<dt>⏎</dt>
<dd>Go to active search result</dd>
<dt>+</dt>
<dd>Collapse/expand all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../../";
window.currentCrate = "alloc";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>
distrib
>
Mageia
>
6
>
armv7hl
>
media
>
core-updates
>
by-pkgid
>
564935689ab5527f955e5449ded02799
>
files
>
37
