141 lines
11 KiB
HTML
141 lines
11 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 `Arena` type in crate `pretty`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, Arena">
|
|||
|
|
|
|||
|
|
<title>pretty::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 type">
|
|||
|
|
<!--[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'>Type Definition Arena</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-DocAllocator%3C%27a%3E">DocAllocator<'a></a></div></div><p class='location'><a href='index.html'>pretty</a></p><script>window.sidebarCurrent = {name: 'Arena', ty: 'type', relpath: ''};</script><script defer src="sidebar-items.js"></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'>Type Definition <a href='index.html'>pretty</a>::<wbr><a class="type" href=''>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/pretty/lib.rs.html#149' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<pre class='rust typedef'>type Arena<'a> = <a class="struct" href="../typed_arena/struct.Arena.html" title="struct typed_arena::Arena">Arena</a><<a class="enum" href="../pretty/enum.Doc.html" title="enum pretty::Doc">Doc</a><'a, <a class="struct" href="../pretty/struct.RefDoc.html" title="struct pretty::RefDoc">RefDoc</a><'a>>>;</pre><div class='docblock'><p>An arena which can be used to allocate <code>Doc</code> values.</p>
|
|||
|
|
</div>
|
|||
|
|
<h2 id='implementations' class='small-section-header'>
|
|||
|
|
Trait Implementations<a href='#implementations' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<h3 id='impl-DocAllocator%3C%27a%3E' class='impl'><span class='in-band'><code>impl<'a> <a class="trait" href="../pretty/trait.DocAllocator.html" title="trait pretty::DocAllocator">DocAllocator</a><'a> for <a class="type" href="../pretty/type.Arena.html" title="type pretty::Arena">Arena</a><'a></code><a href='#impl-DocAllocator%3C%27a%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/pretty/lib.rs.html#151-165' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='associatedtype.Doc' class="type"><span id='Doc.t' class='invisible'><code>type <a href='../pretty/trait.DocAllocator.html#associatedtype.Doc' class="type">Doc</a> = <a class="struct" href="../pretty/struct.RefDoc.html" title="struct pretty::RefDoc">RefDoc</a><'a></code></span></h4>
|
|||
|
|
<h4 id='method.alloc' class="method"><span id='alloc.v' class='invisible'><code>fn <a href='../pretty/trait.DocAllocator.html#tymethod.alloc' class='fnname'>alloc</a>(&'a self, doc: <a class="enum" href="../pretty/enum.Doc.html" title="enum pretty::Doc">Doc</a><'a, Self::<a class="type" href="../pretty/trait.DocAllocator.html#associatedtype.Doc" title="type pretty::DocAllocator::Doc">Doc</a>>) -> Self::<a class="type" href="../pretty/trait.DocAllocator.html#associatedtype.Doc" title="type pretty::DocAllocator::Doc">Doc</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/pretty/lib.rs.html#155-164' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<h4 id='method.nil' class="method"><span id='nil.v' class='invisible'><code>fn <a href='../pretty/trait.DocAllocator.html#method.nil' class='fnname'>nil</a>(&'a self) -> <a class="struct" href="../pretty/struct.DocBuilder.html" title="struct pretty::DocBuilder">DocBuilder</a><'a, Self></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/pretty/lib.rs.html#64-66' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<h4 id='method.newline' class="method"><span id='newline.v' class='invisible'><code>fn <a href='../pretty/trait.DocAllocator.html#method.newline' class='fnname'>newline</a>(&'a self) -> <a class="struct" href="../pretty/struct.DocBuilder.html" title="struct pretty::DocBuilder">DocBuilder</a><'a, Self></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/pretty/lib.rs.html#69-71' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<h4 id='method.space' class="method"><span id='space.v' class='invisible'><code>fn <a href='../pretty/trait.DocAllocator.html#method.space' class='fnname'>space</a>(&'a self) -> <a class="struct" href="../pretty/struct.DocBuilder.html" title="struct pretty::DocBuilder">DocBuilder</a><'a, Self></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/pretty/lib.rs.html#74-76' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<h4 id='method.as_string' class="method"><span id='as_string.v' class='invisible'><code>fn <a href='../pretty/trait.DocAllocator.html#method.as_string' class='fnname'>as_string</a><T: <a class="trait" href="https://doc.rust-lang.org/nightly/alloc/string/trait.ToString.html" title="trait alloc::string::ToString">ToString</a>>(&'a self, t: T) -> <a class="struct" href="../pretty/struct.DocBuilder.html" title="struct pretty::DocBuilder">DocBuilder</a><'a, Self></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/pretty/lib.rs.html#79-81' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<h4 id='method.text' class="method"><span id='text.v' class='invisible'><code>fn <a href='../pretty/trait.DocAllocator.html#method.text' class='fnname'>text</a><T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="https://doc.rust-lang.org/nightly/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a><'a, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>>>(&'a self, data: T) -> <a class="struct" href="../pretty/struct.DocBuilder.html" title="struct pretty::DocBuilder">DocBuilder</a><'a, Self></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/pretty/lib.rs.html#84-88' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<h4 id='method.concat' class="method"><span id='concat.v' class='invisible'><code>fn <a href='../pretty/trait.DocAllocator.html#method.concat' class='fnname'>concat</a><I>(&'a self, docs: I) -> <a class="struct" href="../pretty/struct.DocBuilder.html" title="struct pretty::DocBuilder">DocBuilder</a><'a, Self> <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html" title="trait core::iter::traits::IntoIterator">IntoIterator</a>,<br> I::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::IntoIterator::Item">Item</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="../pretty/enum.Doc.html" title="enum pretty::Doc">Doc</a><'a, Self::<a class="type" href="../pretty/trait.DocAllocator.html#associatedtype.Doc" title="type pretty::DocAllocator::Doc">Doc</a>>>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/pretty/lib.rs.html#91-96' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
</div></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 = "pretty";
|
|||
|
|
</script>
|
|||
|
|
<script src="../main.js"></script>
|
|||
|
|
<script defer src="../search-index.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|