mirror of
https://github.com/quickwit-oss/tantivy.git
synced 2026-05-29 14:40:40 +00:00
Documentation for tantivy-search/tantivy@9f5498d
This commit is contained in:
Travis CI User
142
atomicwrites/struct.AtomicFile.html
Normal file
142
atomicwrites/struct.AtomicFile.html
Normal file
@@ -0,0 +1,142 @@
|
||||
<!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 `AtomicFile` struct in crate `atomicwrites`.">
|
||||
<meta name="keywords" content="rust, rustlang, rust-lang, AtomicFile">
|
||||
|
||||
<title>atomicwrites::AtomicFile - 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 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">☰</div>
|
||||
|
||||
<p class='location'>Struct AtomicFile</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_with_tmpdir">new_with_tmpdir</a><a href="#method.path">path</a><a href="#method.write">write</a></div></div><p class='location'><a href='index.html'>atomicwrites</a></p><script>window.sidebarCurrent = {name: 'AtomicFile', 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'>atomicwrites</a>::<wbr><a class="struct" href=''>AtomicFile</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/atomicwrites/lib.rs.html#72-76' title='goto source code'>[src]</a></span></h1>
|
||||
<pre class='rust struct'>pub struct AtomicFile { /* fields omitted */ }</pre>
|
||||
<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="../atomicwrites/struct.AtomicFile.html" title="struct atomicwrites::AtomicFile">AtomicFile</a></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/atomicwrites/lib.rs.html#79-126' 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><P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="struct" href="https://doc.rust-lang.org/nightly/std/path/struct.Path.html" title="struct std::path::Path">Path</a>>>(path: P, overwrite: <a class="enum" href="../atomicwrites/enum.OverwriteBehavior.html" title="enum atomicwrites::OverwriteBehavior">OverwriteBehavior</a>) -> Self</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/atomicwrites/lib.rs.html#84-87' title='goto source code'>[src]</a></span></h4>
|
||||
<div class='docblock'><p>Helper for writing to <code>path</code> in write-only mode.</p>
|
||||
<p>If <code>DisallowOverwrite</code> is given, errors will be returned from <code>self.write(...)</code> if the file
|
||||
exists.</p>
|
||||
</div><h4 id='method.new_with_tmpdir' class="method"><span id='new_with_tmpdir.v' class='invisible'><code>pub fn <a href='#method.new_with_tmpdir' class='fnname'>new_with_tmpdir</a><P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="struct" href="https://doc.rust-lang.org/nightly/std/path/struct.Path.html" title="struct std::path::Path">Path</a>>>(<br> path: P, <br> overwrite: <a class="enum" href="../atomicwrites/enum.OverwriteBehavior.html" title="enum atomicwrites::OverwriteBehavior">OverwriteBehavior</a>, <br> tmpdir: P<br>) -> Self</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/atomicwrites/lib.rs.html#89-95' title='goto source code'>[src]</a></span></h4>
|
||||
<h4 id='method.path' class="method"><span id='path.v' class='invisible'><code>pub fn <a href='#method.path' class='fnname'>path</a>(&self) -> &<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/atomicwrites/lib.rs.html#105' title='goto source code'>[src]</a></span></h4>
|
||||
<div class='docblock'><p>Get the target filepath.</p>
|
||||
</div><h4 id='method.write' class="method"><span id='write.v' class='invisible'><code>pub fn <a href='#method.write' class='fnname'>write</a><T, E, F>(&self, f: F) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <a class="enum" href="../atomicwrites/enum.Error.html" title="enum atomicwrites::Error">Error</a><E>> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(&mut <a class="struct" href="https://doc.rust-lang.org/nightly/std/fs/struct.File.html" title="struct std::fs::File">File</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, E>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/atomicwrites/lib.rs.html#110-125' title='goto source code'>[src]</a></span></h4>
|
||||
<div class='docblock'><p>Open a temporary file, call <code>f</code> on it (which is supposed to write to it), then move the
|
||||
file atomically to <code>self.path</code>.</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>⏎</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 = "atomicwrites";
|
||||
</script>
|
||||
<script src="../main.js"></script>
|
||||
<script defer src="../search-index.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user