mentat/rusqlite/enum.ErrorCode.html
2018-08-22 17:04:13 +00:00

198 lines
No EOL
21 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 `ErrorCode` enum in crate `rusqlite`.">
<meta name="keywords" content="rust, rustlang, rust-lang, ErrorCode">
<title>rusqlite::ErrorCode - 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">&#9776;</div>
<p class='location'>Enum ErrorCode</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#variants">Variants</a><div class="sidebar-links"><a href="#variant.InternalMalfunction">InternalMalfunction</a><a href="#variant.PermissionDenied">PermissionDenied</a><a href="#variant.OperationAborted">OperationAborted</a><a href="#variant.DatabaseBusy">DatabaseBusy</a><a href="#variant.DatabaseLocked">DatabaseLocked</a><a href="#variant.OutOfMemory">OutOfMemory</a><a href="#variant.ReadOnly">ReadOnly</a><a href="#variant.OperationInterrupted">OperationInterrupted</a><a href="#variant.SystemIOFailure">SystemIOFailure</a><a href="#variant.DatabaseCorrupt">DatabaseCorrupt</a><a href="#variant.NotFound">NotFound</a><a href="#variant.DiskFull">DiskFull</a><a href="#variant.CannotOpen">CannotOpen</a><a href="#variant.FileLockingProtocolFailed">FileLockingProtocolFailed</a><a href="#variant.SchemaChanged">SchemaChanged</a><a href="#variant.TooBig">TooBig</a><a href="#variant.ConstraintViolation">ConstraintViolation</a><a href="#variant.TypeMismatch">TypeMismatch</a><a href="#variant.APIMisuse">APIMisuse</a><a href="#variant.NoLargeFileSupport">NoLargeFileSupport</a><a href="#variant.AuthorizationForStatementDenied">AuthorizationForStatementDenied</a><a href="#variant.ParameterOutOfRange">ParameterOutOfRange</a><a href="#variant.NotADatabase">NotADatabase</a><a href="#variant.Unknown">Unknown</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Copy">Copy</a><a href="#impl-Clone">Clone</a><a href="#impl-Eq">Eq</a><a href="#impl-PartialEq%3CErrorCode%3E">PartialEq&lt;ErrorCode&gt;</a></div></div><p class='location'><a href='index.html'>rusqlite</a></p><script>window.sidebarCurrent = {name: 'ErrorCode', 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'>rusqlite</a>::<wbr><a class="enum" href=''>ErrorCode</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/libsqlite3_sys/error.rs.html#7-56' title='goto source code'>[src]</a></span></h1>
<pre class='rust enum'>pub enum ErrorCode {
InternalMalfunction,
PermissionDenied,
OperationAborted,
DatabaseBusy,
DatabaseLocked,
OutOfMemory,
ReadOnly,
OperationInterrupted,
SystemIOFailure,
DatabaseCorrupt,
NotFound,
DiskFull,
CannotOpen,
FileLockingProtocolFailed,
SchemaChanged,
TooBig,
ConstraintViolation,
TypeMismatch,
APIMisuse,
NoLargeFileSupport,
AuthorizationForStatementDenied,
ParameterOutOfRange,
NotADatabase,
Unknown,
}</pre><div class='docblock'><p>Error Codes</p>
</div><h2 id='variants' class='variants small-section-header'>
Variants<a href='#variants' class='anchor'></a></h2>
<span id="variant.InternalMalfunction" class="variant small-section-header"><a href="#variant.InternalMalfunction" class="anchor field"></a><span id='InternalMalfunction.v' class='invisible'><code>InternalMalfunction</code></span></span><div class='docblock'><p>Internal logic error in SQLite</p>
</div><span id="variant.PermissionDenied" class="variant small-section-header"><a href="#variant.PermissionDenied" class="anchor field"></a><span id='PermissionDenied.v' class='invisible'><code>PermissionDenied</code></span></span><div class='docblock'><p>Access permission denied</p>
</div><span id="variant.OperationAborted" class="variant small-section-header"><a href="#variant.OperationAborted" class="anchor field"></a><span id='OperationAborted.v' class='invisible'><code>OperationAborted</code></span></span><div class='docblock'><p>Callback routine requested an abort</p>
</div><span id="variant.DatabaseBusy" class="variant small-section-header"><a href="#variant.DatabaseBusy" class="anchor field"></a><span id='DatabaseBusy.v' class='invisible'><code>DatabaseBusy</code></span></span><div class='docblock'><p>The database file is locked</p>
</div><span id="variant.DatabaseLocked" class="variant small-section-header"><a href="#variant.DatabaseLocked" class="anchor field"></a><span id='DatabaseLocked.v' class='invisible'><code>DatabaseLocked</code></span></span><div class='docblock'><p>A table in the database is locked</p>
</div><span id="variant.OutOfMemory" class="variant small-section-header"><a href="#variant.OutOfMemory" class="anchor field"></a><span id='OutOfMemory.v' class='invisible'><code>OutOfMemory</code></span></span><div class='docblock'><p>A malloc() failed</p>
</div><span id="variant.ReadOnly" class="variant small-section-header"><a href="#variant.ReadOnly" class="anchor field"></a><span id='ReadOnly.v' class='invisible'><code>ReadOnly</code></span></span><div class='docblock'><p>Attempt to write a readonly database</p>
</div><span id="variant.OperationInterrupted" class="variant small-section-header"><a href="#variant.OperationInterrupted" class="anchor field"></a><span id='OperationInterrupted.v' class='invisible'><code>OperationInterrupted</code></span></span><div class='docblock'><p>Operation terminated by sqlite3_interrupt()</p>
</div><span id="variant.SystemIOFailure" class="variant small-section-header"><a href="#variant.SystemIOFailure" class="anchor field"></a><span id='SystemIOFailure.v' class='invisible'><code>SystemIOFailure</code></span></span><div class='docblock'><p>Some kind of disk I/O error occurred</p>
</div><span id="variant.DatabaseCorrupt" class="variant small-section-header"><a href="#variant.DatabaseCorrupt" class="anchor field"></a><span id='DatabaseCorrupt.v' class='invisible'><code>DatabaseCorrupt</code></span></span><div class='docblock'><p>The database disk image is malformed</p>
</div><span id="variant.NotFound" class="variant small-section-header"><a href="#variant.NotFound" class="anchor field"></a><span id='NotFound.v' class='invisible'><code>NotFound</code></span></span><div class='docblock'><p>Unknown opcode in sqlite3_file_control()</p>
</div><span id="variant.DiskFull" class="variant small-section-header"><a href="#variant.DiskFull" class="anchor field"></a><span id='DiskFull.v' class='invisible'><code>DiskFull</code></span></span><div class='docblock'><p>Insertion failed because database is full</p>
</div><span id="variant.CannotOpen" class="variant small-section-header"><a href="#variant.CannotOpen" class="anchor field"></a><span id='CannotOpen.v' class='invisible'><code>CannotOpen</code></span></span><div class='docblock'><p>Unable to open the database file</p>
</div><span id="variant.FileLockingProtocolFailed" class="variant small-section-header"><a href="#variant.FileLockingProtocolFailed" class="anchor field"></a><span id='FileLockingProtocolFailed.v' class='invisible'><code>FileLockingProtocolFailed</code></span></span><div class='docblock'><p>Database lock protocol error</p>
</div><span id="variant.SchemaChanged" class="variant small-section-header"><a href="#variant.SchemaChanged" class="anchor field"></a><span id='SchemaChanged.v' class='invisible'><code>SchemaChanged</code></span></span><div class='docblock'><p>The database schema changed</p>
</div><span id="variant.TooBig" class="variant small-section-header"><a href="#variant.TooBig" class="anchor field"></a><span id='TooBig.v' class='invisible'><code>TooBig</code></span></span><div class='docblock'><p>String or BLOB exceeds size limit</p>
</div><span id="variant.ConstraintViolation" class="variant small-section-header"><a href="#variant.ConstraintViolation" class="anchor field"></a><span id='ConstraintViolation.v' class='invisible'><code>ConstraintViolation</code></span></span><div class='docblock'><p>Abort due to constraint violation</p>
</div><span id="variant.TypeMismatch" class="variant small-section-header"><a href="#variant.TypeMismatch" class="anchor field"></a><span id='TypeMismatch.v' class='invisible'><code>TypeMismatch</code></span></span><div class='docblock'><p>Data type mismatch</p>
</div><span id="variant.APIMisuse" class="variant small-section-header"><a href="#variant.APIMisuse" class="anchor field"></a><span id='APIMisuse.v' class='invisible'><code>APIMisuse</code></span></span><div class='docblock'><p>Library used incorrectly</p>
</div><span id="variant.NoLargeFileSupport" class="variant small-section-header"><a href="#variant.NoLargeFileSupport" class="anchor field"></a><span id='NoLargeFileSupport.v' class='invisible'><code>NoLargeFileSupport</code></span></span><div class='docblock'><p>Uses OS features not supported on host</p>
</div><span id="variant.AuthorizationForStatementDenied" class="variant small-section-header"><a href="#variant.AuthorizationForStatementDenied" class="anchor field"></a><span id='AuthorizationForStatementDenied.v' class='invisible'><code>AuthorizationForStatementDenied</code></span></span><div class='docblock'><p>Authorization denied</p>
</div><span id="variant.ParameterOutOfRange" class="variant small-section-header"><a href="#variant.ParameterOutOfRange" class="anchor field"></a><span id='ParameterOutOfRange.v' class='invisible'><code>ParameterOutOfRange</code></span></span><div class='docblock'><p>2nd parameter to sqlite3_bind out of range</p>
</div><span id="variant.NotADatabase" class="variant small-section-header"><a href="#variant.NotADatabase" class="anchor field"></a><span id='NotADatabase.v' class='invisible'><code>NotADatabase</code></span></span><div class='docblock'><p>File opened that is not a database file</p>
</div><span id="variant.Unknown" class="variant small-section-header"><a href="#variant.Unknown" class="anchor field"></a><span id='Unknown.v' class='invisible'><code>Unknown</code></span></span><div class='docblock'><p>SQL error or missing database</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 <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="../rusqlite/enum.ErrorCode.html" title="enum rusqlite::ErrorCode">ErrorCode</a></code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/libsqlite3_sys/error.rs.html#6' 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, __arg_0: &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="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Error.html" title="struct core::fmt::Error">Error</a>&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/libsqlite3_sys/error.rs.html#6' 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-Copy' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> for <a class="enum" href="../rusqlite/enum.ErrorCode.html" title="enum rusqlite::ErrorCode">ErrorCode</a></code><a href='#impl-Copy' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/libsqlite3_sys/error.rs.html#6' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'></div><h3 id='impl-Clone' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="enum" href="../rusqlite/enum.ErrorCode.html" title="enum rusqlite::ErrorCode">ErrorCode</a></code><a href='#impl-Clone' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/libsqlite3_sys/error.rs.html#6' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&amp;self) -&gt; <a class="enum" href="../rusqlite/enum.ErrorCode.html" title="enum rusqlite::ErrorCode">ErrorCode</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/libsqlite3_sys/error.rs.html#6' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&amp;mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self)</code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#112-114' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
</div></div><h3 id='impl-Eq' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> for <a class="enum" href="../rusqlite/enum.ErrorCode.html" title="enum rusqlite::ErrorCode">ErrorCode</a></code><a href='#impl-Eq' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/libsqlite3_sys/error.rs.html#6' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'></div><h3 id='impl-PartialEq%3CErrorCode%3E' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a>&lt;<a class="enum" href="../rusqlite/enum.ErrorCode.html" title="enum rusqlite::ErrorCode">ErrorCode</a>&gt; for <a class="enum" href="../rusqlite/enum.ErrorCode.html" title="enum rusqlite::ErrorCode">ErrorCode</a></code><a href='#impl-PartialEq%3CErrorCode%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/libsqlite3_sys/error.rs.html#6' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.eq' class="method"><span id='eq.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq' class='fnname'>eq</a>(&amp;self, __arg_0: &amp;<a class="enum" href="../rusqlite/enum.ErrorCode.html" title="enum rusqlite::ErrorCode">ErrorCode</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/libsqlite3_sys/error.rs.html#6' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
</div><h4 id='method.ne' class="method"><span id='ne.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne' class='fnname'>ne</a>(&amp;self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Rhs) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#121' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>This method tests for <code>!=</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>&#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 = "rusqlite";
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>