mirror of
https://github.com/quickwit-oss/tantivy.git
synced 2026-01-17 06:22:54 +00:00
189 lines
8.8 KiB
HTML
189 lines
8.8 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 `tempfile` crate.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, tempfile">
|
||
|
||
<title>tempfile - 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 tempfile</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'tempfile', 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=''>tempfile</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/tempfile/lib.rs.html#1-57' title='goto source code'>[src]</a></span></h1>
|
||
<div class='docblock'><p>Securely create and manage temporary files. Temporary files created by this create are
|
||
automatically deleted.</p>
|
||
<p>This crate provides two temporary file variants: a <code>tempfile()</code> function that returns standard
|
||
<code>File</code> objects and <code>NamedTempFile</code>. When choosing between the variants, prefer <code>tempfile()</code>
|
||
unless you either need to know the file's path or to be able to persist it.</p>
|
||
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">tempfile</span>::<span class="ident">tempfile</span>;
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">fs</span>::<span class="ident">File</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">file</span>: <span class="ident">File</span> <span class="op">=</span> <span class="ident">tempfile</span>().<span class="ident">expect</span>(<span class="string">"failed to create temporary file"</span>);</pre>
|
||
<h1 id="differences" class="section-header"><a href="#differences">Differences</a></h1><h2 id="resource-leaking" class="section-header"><a href="#resource-leaking">Resource Leaking</a></h2>
|
||
<p><code>tempfile()</code> will (almost) never fail to cleanup temporary files but <code>NamedTempFile</code> will if
|
||
its destructor doesn't run. This is because <code>tempfile()</code> relies on the OS to cleanup the
|
||
underlying file so the file while <code>NamedTempFile</code> relies on its destructor to do so.</p>
|
||
<h2 id="security" class="section-header"><a href="#security">Security</a></h2>
|
||
<p>In the presence of pathological temporary file cleaner, relying on file paths is unsafe because
|
||
a temporary file cleaner could delete the temporary file which an attacker could then replace.</p>
|
||
<p><code>tempfile()</code> doesn't rely on file paths so this isn't an issue. However, <code>NamedTempFile</code> does
|
||
rely on file paths.</p>
|
||
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.NamedTempFile.html"
|
||
title='struct tempfile::NamedTempFile'>NamedTempFile</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A named temporary file.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.NamedTempFileOptions.html"
|
||
title='struct tempfile::NamedTempFileOptions'>NamedTempFileOptions</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Create a new temporary file with custom parameters.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.PersistError.html"
|
||
title='struct tempfile::PersistError'>PersistError</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Error returned when persisting a temporary file fails</p>
|
||
|
||
</td>
|
||
</tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.tempfile.html"
|
||
title='fn tempfile::tempfile'>tempfile</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Create an unnamed temporary file.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="fn" href="fn.tempfile_in.html"
|
||
title='fn tempfile::tempfile_in'>tempfile_in</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Create an unnamed temporary file in the specified directory.</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 = "tempfile";
|
||
</script>
|
||
<script src="../main.js"></script>
|
||
<script defer src="../search-index.js"></script>
|
||
</body>
|
||
</html> |