rust/tantivy
1
0
Fork 0
mirror of https://github.com/quickwit-oss/tantivy.git synced 2026-01-14 04:52:54 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
tantivy/tempdir/struct.TempDir.html
Travis CI User d4ca9ce21b Documentation for tantivy-search/tantivy@9f5498d
2018-02-12 02:52:50 +00:00

280 lines
25 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 `TempDir` struct in crate `tempdir`.">
<meta name="keywords" content="rust, rustlang, rust-lang, TempDir">
<title>tempdir::TempDir - 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>
<link rel="shortcut icon" href="https://www.rust-lang.org/favicon.ico">
</head>
<body class="rustdoc struct">
<!--[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">&#9776;</div>
<a href='../tempdir/index.html'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png' alt='logo' width='100'></a>
<p class='location'>Struct TempDir</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.new_in">new_in</a><a href="#method.path">path</a><a href="#method.into_path">into_path</a><a href="#method.close">close</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-AsRef%3CPath%3E">AsRef&lt;Path&gt;</a><a href="#impl-Debug">Debug</a><a href="#impl-Drop">Drop</a></div></div><p class='location'><a href='index.html'>tempdir</a></p><script>window.sidebarCurrent = {name: 'TempDir', ty: 'struct', 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'>Struct <a href='index.html'>tempdir</a>::<wbr><a class="struct" href=''>TempDir</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'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../src/tempdir/lib.rs.html#115-117' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct TempDir { /* fields omitted */ }</pre><div class='docblock'><p>A directory in the filesystem that is automatically deleted when
it goes out of scope.</p>
<p>The <a href="struct.TempDir.html"><code>TempDir</code></a> type creates a directory on the file system that
is deleted once it goes out of scope. At construction, the
<code>TempDir</code> creates a new directory with a randomly generated name,
and with a prefix of your choosing.</p>
<p>The default constructor, <a href="struct.TempDir.html#method.new"><code>TempDir::new</code></a>, creates directories in
the location returned by <a href="https://doc.rust-lang.org/std/env/fn.temp_dir.html"><code>std::env::temp_dir()</code></a>, but <code>TempDir</code>
can be configured to manage a temporary directory in any location
by constructing with <a href="struct.TempDir.html#method.new_in"><code>TempDir::new_in</code></a>.</p>
<p>After creating a <code>TempDir</code>, work with the file system by doing
standard <a href="http://doc.rust-lang.org/std/fs/index.html"><code>std::fs</code></a> file system operations on its <a href="http://doc.rust-lang.org/std/path/struct.Path.html"><code>Path</code></a>,
which can be retrieved with <a href="struct.TempDir.html#method.path"><code>TempDir::path</code></a>. Once the <code>TempDir</code>
value is dropped, the directory at the path will be deleted, along
with any files and directories it contains. It is your responsibility
to ensure that no further file system operations are attempted
inside the temporary directory once it has been deleted.</p>
<p>Various platform-specific conditions may cause <code>TempDir</code> to fail
to delete the underlying directory. It's important to ensure that
handles (like <a href="http://doc.rust-lang.org/std/fs/struct.File.html"><code>File</code></a> and <a href="http://doc.rust-lang.org/std/fs/struct.ReadDir.html"><code>ReadDir</code></a>) to files inside the
directory are dropped before the <code>TempDir</code> goes out of scope. The
<code>TempDir</code> destructor will silently ignore any errors in deleting
the directory; to instead handle errors call <a href="struct.TempDir.html#method.close"><code>TempDir::close</code></a>.</p>
<p>Note that if the program exits before the <code>TempDir</code> destructor is
run, such as via <a href="http://doc.rust-lang.org/std/process/fn.exit.html"><code>std::process::exit</code></a>, by segfaulting, or by
receiving a signal like <code>SIGINT</code>, then the temporary directory
will not be deleted.</p>
</div>
<h2 id='methods' class='small-section-header'>
Methods<a href='#methods' class='anchor'></a>
</h2>
<h3 id='impl' class='impl'><span class='in-band'><code>impl <a class="struct" href="../tempdir/struct.TempDir.html" title="struct tempdir::TempDir">TempDir</a></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tempdir/lib.rs.html#128-333' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>pub fn <a href='#method.new' class='fnname'>new</a>(prefix: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a>&lt;<a class="struct" href="../tempdir/struct.TempDir.html" title="struct tempdir::TempDir">TempDir</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tempdir/lib.rs.html#159-161' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Attempts to make a temporary directory inside of <code>env::temp_dir()</code> whose
name will have the prefix, <code>prefix</code>. The directory and
everything inside it will be automatically deleted once the
returned <code>TempDir</code> is destroyed.</p>
<h1 id="errors" class="section-header"><a href="#errors">Errors</a></h1>
<p>If the directory can not be created, <code>Err</code> is returned.</p>
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">fs</span>::<span class="ident">File</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">Write</span>;
<span class="kw">use</span> <span class="ident">tempdir</span>::<span class="ident">TempDir</span>;
<span class="comment">// Create a directory inside of `std::env::temp_dir()`, named with</span>
<span class="comment">// the prefix, &quot;example&quot;.</span>
<span class="kw">let</span> <span class="ident">tmp_dir</span> <span class="op">=</span> <span class="ident">TempDir</span>::<span class="ident">new</span>(<span class="string">&quot;example&quot;</span>)<span class="question-mark">?</span>;
<span class="kw">let</span> <span class="ident">file_path</span> <span class="op">=</span> <span class="ident">tmp_dir</span>.<span class="ident">path</span>().<span class="ident">join</span>(<span class="string">&quot;my-temporary-note.txt&quot;</span>);
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">tmp_file</span> <span class="op">=</span> <span class="ident">File</span>::<span class="ident">create</span>(<span class="ident">file_path</span>)<span class="question-mark">?</span>;
<span class="macro">writeln</span><span class="macro">!</span>(<span class="ident">tmp_file</span>, <span class="string">&quot;Brian was here. Briefly.&quot;</span>)<span class="question-mark">?</span>;
<span class="comment">// `tmp_dir` goes out of scope, the directory as well as</span>
<span class="comment">// `tmp_file` will be deleted here.</span></pre>
</div><h4 id='method.new_in' class="method"><span id='new_in.v' class='invisible'><code>pub fn <a href='#method.new_in' class='fnname'>new_in</a>&lt;P:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/std/path/struct.Path.html" title="struct std::path::Path">Path</a>&gt;&gt;(tmpdir: P, prefix: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a>&lt;<a class="struct" href="../tempdir/struct.TempDir.html" title="struct tempdir::TempDir">TempDir</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tempdir/lib.rs.html#190-221' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Attempts to make a temporary directory inside of <code>tmpdir</code>
whose name will have the prefix <code>prefix</code>. The directory and
everything inside it will be automatically deleted once the
returned <code>TempDir</code> is destroyed.</p>
<h1 id="errors-1" class="section-header"><a href="#errors-1">Errors</a></h1>
<p>If the directory can not be created, <code>Err</code> is returned.</p>
<h1 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">fs</span>::{<span class="self">self</span>, <span class="ident">File</span>};
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">Write</span>;
<span class="kw">use</span> <span class="ident">tempdir</span>::<span class="ident">TempDir</span>;
<span class="comment">// Create a directory inside of the current directory, named with</span>
<span class="comment">// the prefix, &quot;example&quot;.</span>
<span class="kw">let</span> <span class="ident">tmp_dir</span> <span class="op">=</span> <span class="ident">TempDir</span>::<span class="ident">new_in</span>(<span class="string">&quot;.&quot;</span>, <span class="string">&quot;example&quot;</span>)<span class="question-mark">?</span>;
<span class="kw">let</span> <span class="ident">file_path</span> <span class="op">=</span> <span class="ident">tmp_dir</span>.<span class="ident">path</span>().<span class="ident">join</span>(<span class="string">&quot;my-temporary-note.txt&quot;</span>);
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">tmp_file</span> <span class="op">=</span> <span class="ident">File</span>::<span class="ident">create</span>(<span class="ident">file_path</span>)<span class="question-mark">?</span>;
<span class="macro">writeln</span><span class="macro">!</span>(<span class="ident">tmp_file</span>, <span class="string">&quot;Brian was here. Briefly.&quot;</span>)<span class="question-mark">?</span>;</pre>
</div><h4 id='method.path' class="method"><span id='path.v' class='invisible'><code>pub fn <a href='#method.path' class='fnname'>path</a>(&amp;self) -&gt; &amp;<a class="struct" href="https://doc.rust-lang.org/nightly/std/path/struct.Path.html" title="struct std::path::Path">Path</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tempdir/lib.rs.html#251-253' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Accesses the <a href="http://doc.rust-lang.org/std/path/struct.Path.html"><code>Path</code></a> to the temporary directory.</p>
<h1 id="examples-2" class="section-header"><a href="#examples-2">Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">tempdir</span>::<span class="ident">TempDir</span>;
<span class="kw">let</span> <span class="ident">tmp_path</span>;
{
<span class="kw">let</span> <span class="ident">tmp_dir</span> <span class="op">=</span> <span class="ident">TempDir</span>::<span class="ident">new</span>(<span class="string">&quot;example&quot;</span>)<span class="question-mark">?</span>;
<span class="ident">tmp_path</span> <span class="op">=</span> <span class="ident">tmp_dir</span>.<span class="ident">path</span>().<span class="ident">to_owned</span>();
<span class="comment">// Check that the temp directory actually exists.</span>
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">tmp_path</span>.<span class="ident">exists</span>());
<span class="comment">// End of `tmp_dir` scope, directory will be deleted</span>
}
<span class="comment">// Temp directory should be deleted by now</span>
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">tmp_path</span>.<span class="ident">exists</span>(), <span class="bool-val">false</span>);</pre>
</div><h4 id='method.into_path' class="method"><span id='into_path.v' class='invisible'><code>pub fn <a href='#method.into_path' class='fnname'>into_path</a>(self) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/std/path/struct.PathBuf.html" title="struct std::path::PathBuf">PathBuf</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tempdir/lib.rs.html#280-282' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Unwraps the <a href="http://doc.rust-lang.org/std/path/struct.Path.html"><code>Path</code></a> contained in the <code>TempDir</code> and
returns it. This destroys the <code>TempDir</code> without deleting the
directory represented by the returned <code>Path</code>.</p>
<h1 id="examples-3" class="section-header"><a href="#examples-3">Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">fs</span>;
<span class="kw">use</span> <span class="ident">tempdir</span>::<span class="ident">TempDir</span>;
<span class="kw">let</span> <span class="ident">tmp_dir</span> <span class="op">=</span> <span class="ident">TempDir</span>::<span class="ident">new</span>(<span class="string">&quot;example&quot;</span>)<span class="question-mark">?</span>;
<span class="comment">// Convert `tmp_dir` into a `Path`, destroying the `TempDir`</span>
<span class="comment">// without deleting the directory.</span>
<span class="kw">let</span> <span class="ident">tmp_path</span> <span class="op">=</span> <span class="ident">tmp_dir</span>.<span class="ident">into_path</span>();
<span class="comment">// Delete the temporary directory ourselves.</span>
<span class="ident">fs</span>::<span class="ident">remove_dir_all</span>(<span class="ident">tmp_path</span>)<span class="question-mark">?</span>;</pre>
</div><h4 id='method.close' class="method"><span id='close.v' class='invisible'><code>pub fn <a href='#method.close' class='fnname'>close</a>(self) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tempdir/lib.rs.html#325-332' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Closes and removes the temporary directory, returing a <code>Result</code>.</p>
<p>Although <code>TempDir</code> removes the directory on drop, in the destructor
any errors are ignored. To detect errors cleaning up the temporary
directory, call <code>close</code> instead.</p>
<h1 id="errors-2" class="section-header"><a href="#errors-2">Errors</a></h1>
<p>This function may return a variety of <a href="http://doc.rust-lang.org/std/io/struct.Error.html"><code>std::io::Error</code></a>s that result from deleting
the files and directories contained with the temporary directory,
as well as from deleting the temporary directory itself. These errors
may be platform specific.</p>
<h1 id="examples-4" class="section-header"><a href="#examples-4">Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">fs</span>::<span class="ident">File</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">Write</span>;
<span class="kw">use</span> <span class="ident">tempdir</span>::<span class="ident">TempDir</span>;
<span class="comment">// Create a directory inside of `std::env::temp_dir()`, named with</span>
<span class="comment">// the prefix, &quot;example&quot;.</span>
<span class="kw">let</span> <span class="ident">tmp_dir</span> <span class="op">=</span> <span class="ident">TempDir</span>::<span class="ident">new</span>(<span class="string">&quot;example&quot;</span>)<span class="question-mark">?</span>;
<span class="kw">let</span> <span class="ident">file_path</span> <span class="op">=</span> <span class="ident">tmp_dir</span>.<span class="ident">path</span>().<span class="ident">join</span>(<span class="string">&quot;my-temporary-note.txt&quot;</span>);
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">tmp_file</span> <span class="op">=</span> <span class="ident">File</span>::<span class="ident">create</span>(<span class="ident">file_path</span>)<span class="question-mark">?</span>;
<span class="macro">writeln</span><span class="macro">!</span>(<span class="ident">tmp_file</span>, <span class="string">&quot;Brian was here. Briefly.&quot;</span>)<span class="question-mark">?</span>;
<span class="comment">// By closing the `TempDir` explicitly we can check that it has</span>
<span class="comment">// been deleted successfully. If we don&#39;t close it explicitly,</span>
<span class="comment">// the directory will still be deleted when `tmp_dir` goes out</span>
<span class="comment">// of scope, but we won&#39;t know whether deleting the directory</span>
<span class="comment">// succeeded.</span>
<span class="ident">drop</span>(<span class="ident">tmp_file</span>);
<span class="ident">tmp_dir</span>.<span class="ident">close</span>()<span class="question-mark">?</span>;</pre>
</div></div>
<h2 id='implementations' class='small-section-header'>
Trait Implementations<a href='#implementations' class='anchor'></a>
</h2>
<h3 id='impl-AsRef%3CPath%3E' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/std/path/struct.Path.html" title="struct std::path::Path">Path</a>&gt; for <a class="struct" href="../tempdir/struct.TempDir.html" title="struct tempdir::TempDir">TempDir</a></code><a href='#impl-AsRef%3CPath%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tempdir/lib.rs.html#335-339' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.as_ref' class="method"><span id='as_ref.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html#tymethod.as_ref' class='fnname'>as_ref</a>(&amp;self) -&gt; &amp;<a class="struct" href="https://doc.rust-lang.org/nightly/std/path/struct.Path.html" title="struct std::path::Path">Path</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tempdir/lib.rs.html#336-338' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Performs the conversion.</p>
</div></div><h3 id='impl-Debug' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../tempdir/struct.TempDir.html" title="struct tempdir::TempDir">TempDir</a></code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tempdir/lib.rs.html#341-347' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tempdir/lib.rs.html#342-346' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
</div></div><h3 id='impl-Drop' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html" title="trait core::ops::drop::Drop">Drop</a> for <a class="struct" href="../tempdir/struct.TempDir.html" title="struct tempdir::TempDir">TempDir</a></code><a href='#impl-Drop' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tempdir/lib.rs.html#349-356' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.drop' class="method"><span id='drop.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html#tymethod.drop' class='fnname'>drop</a>(&amp;mut self)</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tempdir/lib.rs.html#350-355' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Executes the destructor for this type. <a href="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html#tymethod.drop">Read more</a></p>
</div></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>&#9166;</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 = "tempdir";
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink