179 lines
8.9 KiB
HTML
179 lines
8.9 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="API documentation for the Rust `typed_arena` crate.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, typed_arena">
|
|||
|
|
|
|||
|
|
<title>typed_arena - Rust</title>
|
|||
|
|
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../normalize.css">
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle">
|
|||
|
|
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../dark.css">
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../main.css" id="themeStyle">
|
|||
|
|
<script src="../storage.js"></script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</head>
|
|||
|
|
<body class="rustdoc mod">
|
|||
|
|
<!--[if lte IE 8]>
|
|||
|
|
<div class="warning">
|
|||
|
|
This old browser is unsupported and will most likely display funky
|
|||
|
|
things.
|
|||
|
|
</div>
|
|||
|
|
<![endif]-->
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<nav class="sidebar">
|
|||
|
|
<div class="sidebar-menu">☰</div>
|
|||
|
|
|
|||
|
|
<p class='location'>Crate typed_arena</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'typed_arena', ty: 'mod', relpath: '../'};</script></div>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<div class="theme-picker">
|
|||
|
|
<button id="theme-picker" aria-label="Pick another theme!">
|
|||
|
|
<img src="../brush.svg" width="18" alt="Pick another theme!">
|
|||
|
|
</button>
|
|||
|
|
<div id="theme-choices"></div>
|
|||
|
|
</div>
|
|||
|
|
<script src="../theme.js"></script>
|
|||
|
|
<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'>Crate <a class="mod" href=''>typed_arena</a></span><span class='out-of-band'><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/typed_arena/lib.rs.html#1-316' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<div class='docblock'><p>The arena, a fast but limited type of allocator.</p>
|
|||
|
|
<p>Arenas are a type of allocator that destroy the objects within,
|
|||
|
|
all at once, once the arena itself is destroyed.
|
|||
|
|
They do not support deallocation of individual objects while the arena itself is still alive.
|
|||
|
|
The benefit of an arena is very fast allocation; just a vector push.</p>
|
|||
|
|
<p>This is an equivalent of the old
|
|||
|
|
<a href="https://doc.rust-lang.org/1.1.0/arena/struct.TypedArena.html"><code>arena::TypedArena</code></a>
|
|||
|
|
type that was once distributed with nightly rustc but has since been
|
|||
|
|
removed.</p>
|
|||
|
|
<p>It is slightly less efficient, but simpler internally and uses much less unsafe code.
|
|||
|
|
It is based on a <code>Vec<Vec<T>></code> instead of raw pointers and manual drops.</p>
|
|||
|
|
<h2 id="example" class="section-header"><a href="#example">Example</a></h2>
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">typed_arena</span>::<span class="ident">Arena</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">struct</span> <span class="ident">Monster</span> {
|
|||
|
|
<span class="ident">level</span>: <span class="ident">u32</span>,
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> <span class="ident">monsters</span> <span class="op">=</span> <span class="ident">Arena</span>::<span class="ident">new</span>();
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> <span class="ident">vegeta</span> <span class="op">=</span> <span class="ident">monsters</span>.<span class="ident">alloc</span>(<span class="ident">Monster</span> { <span class="ident">level</span>: <span class="number">9001</span> });
|
|||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">vegeta</span>.<span class="ident">level</span> <span class="op">></span> <span class="number">9000</span>);</pre>
|
|||
|
|
<h2 id="safe-cycles" class="section-header"><a href="#safe-cycles">Safe Cycles</a></h2>
|
|||
|
|
<p>All allocated objects get the same lifetime, so you can safely create cycles
|
|||
|
|
between them. This can be useful for certain data structures, such as graphs
|
|||
|
|
and trees with parent pointers.</p>
|
|||
|
|
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">cell</span>::<span class="ident">Cell</span>;
|
|||
|
|
<span class="kw">use</span> <span class="ident">typed_arena</span>::<span class="ident">Arena</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">struct</span> <span class="ident">CycleParticipant</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> {
|
|||
|
|
<span class="ident">other</span>: <span class="ident">Cell</span><span class="op"><</span><span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">CycleParticipant</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">>></span><span class="op">></span>,
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> <span class="ident">arena</span> <span class="op">=</span> <span class="ident">Arena</span>::<span class="ident">new</span>();
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> <span class="ident">a</span> <span class="op">=</span> <span class="ident">arena</span>.<span class="ident">alloc</span>(<span class="ident">CycleParticipant</span> { <span class="ident">other</span>: <span class="ident">Cell</span>::<span class="ident">new</span>(<span class="prelude-val">None</span>) });
|
|||
|
|
<span class="kw">let</span> <span class="ident">b</span> <span class="op">=</span> <span class="ident">arena</span>.<span class="ident">alloc</span>(<span class="ident">CycleParticipant</span> { <span class="ident">other</span>: <span class="ident">Cell</span>::<span class="ident">new</span>(<span class="prelude-val">None</span>) });
|
|||
|
|
|
|||
|
|
<span class="ident">a</span>.<span class="ident">other</span>.<span class="ident">set</span>(<span class="prelude-val">Some</span>(<span class="ident">b</span>));
|
|||
|
|
<span class="ident">b</span>.<span class="ident">other</span>.<span class="ident">set</span>(<span class="prelude-val">Some</span>(<span class="ident">a</span>));</pre>
|
|||
|
|
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
|||
|
|
<table>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.Arena.html"
|
|||
|
|
title='struct typed_arena::Arena'>Arena</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>An arena of objects of type <code>T</code>.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr></table></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><kbd>?</kbd></dt>
|
|||
|
|
<dd>Show this help dialog</dd>
|
|||
|
|
<dt><kbd>S</kbd></dt>
|
|||
|
|
<dd>Focus the search field</dd>
|
|||
|
|
<dt><kbd>↑</kbd></dt>
|
|||
|
|
<dd>Move up in search results</dd>
|
|||
|
|
<dt><kbd>↓</kbd></dt>
|
|||
|
|
<dd>Move down in search results</dd>
|
|||
|
|
<dt><kbd>↹</kbd></dt>
|
|||
|
|
<dd>Switch tab</dd>
|
|||
|
|
<dt><kbd>⏎</kbd></dt>
|
|||
|
|
<dd>Go to active search result</dd>
|
|||
|
|
<dt><kbd>+</kbd></dt>
|
|||
|
|
<dd>Expand all sections</dd>
|
|||
|
|
<dt><kbd>-</kbd></dt>
|
|||
|
|
<dd>Collapse 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 = "typed_arena";
|
|||
|
|
</script>
|
|||
|
|
<script src="../main.js"></script>
|
|||
|
|
<script defer src="../search-index.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|