mirror of
https://github.com/quickwit-oss/tantivy.git
synced 2026-05-30 07:00:41 +00:00
Documentation for tantivy-search/tantivy@9f5498d
This commit is contained in:
Travis CI User
154
atomicwrites/enum.Error.html
Normal file
154
atomicwrites/enum.Error.html
Normal file
@@ -0,0 +1,154 @@
|
||||
<!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 `Error` enum in crate `atomicwrites`.">
|
||||
<meta name="keywords" content="rust, rustlang, rust-lang, Error">
|
||||
|
||||
<title>atomicwrites::Error - 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 enum">
|
||||
<!--[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'>Enum Error</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#variants">Variants</a><div class="sidebar-links"><a href="#variant.Internal">Internal</a><a href="#variant.User">User</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-From%3CError%3CError%3E%3E">From<Error<Error>></a><a href="#impl-Display">Display</a><a href="#impl-ErrorTrait">ErrorTrait</a></div></div><p class='location'><a href='index.html'>atomicwrites</a></p><script>window.sidebarCurrent = {name: 'Error', ty: 'enum', 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'>Enum <a href='index.html'>atomicwrites</a>::<wbr><a class="enum" href=''>Error</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#30-36' title='goto source code'>[src]</a></span></h1>
|
||||
<pre class='rust enum'>pub enum Error<E> {
|
||||
Internal(<a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>),
|
||||
User(E),
|
||||
}</pre><div class='docblock'><p>Represents an error raised by <code>AtomicFile.write</code>.</p>
|
||||
</div><h2 id='variants' class='variants small-section-header'>
|
||||
Variants<a href='#variants' class='anchor'></a></h2>
|
||||
<span id="variant.Internal" class="variant small-section-header"><a href="#variant.Internal" class="anchor field"></a><span id='Internal.v' class='invisible'><code>Internal(<a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>)</code></span></span><div class='docblock'><p>The error originated in the library itself, while it was either creating a temporary file
|
||||
or moving the file into place.</p>
|
||||
</div><span id="variant.User" class="variant small-section-header"><a href="#variant.User" class="anchor field"></a><span id='User.v' class='invisible'><code>User(E)</code></span></span><div class='docblock'><p>The error originated in the user-supplied callback.</p>
|
||||
</div>
|
||||
<h2 id='implementations' class='small-section-header'>
|
||||
Trait Implementations<a href='#implementations' class='anchor'></a>
|
||||
</h2>
|
||||
<h3 id='impl-Debug' class='impl'><span class='in-band'><code>impl<E: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>> <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="enum" href="../atomicwrites/enum.Error.html" title="enum atomicwrites::Error">Error</a><E></code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/atomicwrites/lib.rs.html#29' 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>(&self, __arg_0: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <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/atomicwrites/lib.rs.html#29' 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-From%3CError%3CError%3E%3E' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="enum" href="../atomicwrites/enum.Error.html" title="enum atomicwrites::Error">Error</a><<a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>>> for <a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a></code><a href='#impl-From%3CError%3CError%3E%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/atomicwrites/lib.rs.html#38-45' title='goto source code'>[src]</a></span></h3>
|
||||
<div class='impl-items'><h4 id='method.from' class="method"><span id='from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(e: <a class="enum" href="../atomicwrites/enum.Error.html" title="enum atomicwrites::Error">Error</a><<a class="struct" href="https://doc.rust-lang.org/nightly/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>>) -> Self</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/atomicwrites/lib.rs.html#39-44' title='goto source code'>[src]</a></span></h4>
|
||||
<div class='docblock'><p>Performs the conversion.</p>
|
||||
</div></div><h3 id='impl-Display' class='impl'><span class='in-band'><code>impl<E: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> for <a class="enum" href="../atomicwrites/enum.Error.html" title="enum atomicwrites::Error">Error</a><E></code><a href='#impl-Display' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/atomicwrites/lib.rs.html#47-54' title='goto source code'>[src]</a></span></h3>
|
||||
<div class='impl-items'><h4 id='method.fmt-1' class="method"><span id='fmt.v-1' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <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/atomicwrites/lib.rs.html#48-53' 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.Display.html#tymethod.fmt">Read more</a></p>
|
||||
</div></div><h3 id='impl-ErrorTrait' class='impl'><span class='in-band'><code>impl<E: <a class="trait" href="https://doc.rust-lang.org/nightly/std/error/trait.Error.html" title="trait std::error::Error">ErrorTrait</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/std/error/trait.Error.html" title="trait std::error::Error">ErrorTrait</a> for <a class="enum" href="../atomicwrites/enum.Error.html" title="enum atomicwrites::Error">Error</a><E></code><a href='#impl-ErrorTrait' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/atomicwrites/lib.rs.html#56-70' title='goto source code'>[src]</a></span></h3>
|
||||
<div class='impl-items'><h4 id='method.description' class="method"><span id='description.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/std/error/trait.Error.html#tymethod.description' class='fnname'>description</a>(&self) -> &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/atomicwrites/lib.rs.html#57-62' title='goto source code'>[src]</a></span></h4>
|
||||
<div class='docblock'><p>A short description of the error. <a href="https://doc.rust-lang.org/nightly/std/error/trait.Error.html#tymethod.description">Read more</a></p>
|
||||
</div><h4 id='method.cause' class="method"><span id='cause.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/std/error/trait.Error.html#method.cause' class='fnname'>cause</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="trait" href="https://doc.rust-lang.org/nightly/std/error/trait.Error.html" title="trait std::error::Error">ErrorTrait</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/atomicwrites/lib.rs.html#64-69' title='goto source code'>[src]</a></span></h4>
|
||||
<div class='docblock'><p>The lower-level cause of this error, if any. <a href="https://doc.rust-lang.org/nightly/std/error/trait.Error.html#method.cause">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>⏎</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