2018-06-21 14:44:35 +00:00
|
|
|
|
<!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 `mentat_sql` crate.">
|
|
|
|
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, mentat_sql">
|
|
|
|
|
|
|
|
|
|
|
|
<title>mentat_sql - 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="../light.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 mentat_sql</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'mentat_sql', 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=''>mentat_sql</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>
|
2018-06-22 17:25:54 +00:00
|
|
|
|
</span><a class='srclink' href='../src/mentat_sql/lib.rs.html#10-273' title='goto source code'>[src]</a></span></h1><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
2018-06-21 14:44:35 +00:00
|
|
|
|
<table>
|
|
|
|
|
|
<tr class=' module-item'>
|
|
|
|
|
|
<td><a class="struct" href="struct.SQLQuery.html"
|
|
|
|
|
|
title='struct mentat_sql::SQLQuery'>SQLQuery</a></td>
|
|
|
|
|
|
<td class='docblock-short'>
|
|
|
|
|
|
<p>We want to accumulate values that will later be substituted into a SQL statement execution.
|
|
|
|
|
|
This struct encapsulates the generated string and the <em>initial</em> argument list.
|
|
|
|
|
|
Additional user-supplied argument bindings, with their placeholders accumulated via
|
|
|
|
|
|
<code>push_bind_param</code>, will be appended to this argument list.</p>
|
|
|
|
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class=' module-item'>
|
|
|
|
|
|
<td><a class="struct" href="struct.SQLiteQueryBuilder.html"
|
|
|
|
|
|
title='struct mentat_sql::SQLiteQueryBuilder'>SQLiteQueryBuilder</a></td>
|
|
|
|
|
|
<td class='docblock-short'>
|
|
|
|
|
|
<p>A QueryBuilder that implements SQLite's specific escaping rules.</p>
|
|
|
|
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
|
|
|
|
|
|
<table>
|
|
|
|
|
|
<tr class=' module-item'>
|
2018-06-22 17:25:54 +00:00
|
|
|
|
<td><a class="enum" href="enum.SQLError.html"
|
|
|
|
|
|
title='enum mentat_sql::SQLError'>SQLError</a></td>
|
2018-06-21 14:44:35 +00:00
|
|
|
|
<td class='docblock-short'>
|
2018-06-22 17:25:54 +00:00
|
|
|
|
|
2018-06-21 14:44:35 +00:00
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class=' module-item'>
|
|
|
|
|
|
<td><a class="enum" href="enum.Value.html"
|
|
|
|
|
|
title='enum mentat_sql::Value'>Value</a></td>
|
|
|
|
|
|
<td class='docblock-short'>
|
|
|
|
|
|
<p>Owning <a href="http://sqlite.org/datatype3.html">dynamic type value</a>. Value's type is typically
|
|
|
|
|
|
dictated by SQLite (not by the caller).</p>
|
|
|
|
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
|
|
|
|
|
|
<table>
|
|
|
|
|
|
<tr class=' module-item'>
|
|
|
|
|
|
<td><a class="trait" href="trait.QueryBuilder.html"
|
|
|
|
|
|
title='trait mentat_sql::QueryBuilder'>QueryBuilder</a></td>
|
|
|
|
|
|
<td class='docblock-short'>
|
|
|
|
|
|
<p>Gratefully based on Diesel's QueryBuilder trait:
|
|
|
|
|
|
https://github.com/diesel-rs/diesel/blob/4885f61b8205f7f3c2cfa03837ed6714831abe6b/diesel/src/query_builder/mod.rs#L56</p>
|
|
|
|
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr class=' module-item'>
|
|
|
|
|
|
<td><a class="trait" href="trait.QueryFragment.html"
|
|
|
|
|
|
title='trait mentat_sql::QueryFragment'>QueryFragment</a></td>
|
|
|
|
|
|
<td class='docblock-short'>
|
|
|
|
|
|
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
|
|
|
|
|
|
<table>
|
|
|
|
|
|
<tr class=' module-item'>
|
|
|
|
|
|
<td><a class="type" href="type.BuildQueryResult.html"
|
|
|
|
|
|
title='type mentat_sql::BuildQueryResult'>BuildQueryResult</a></td>
|
|
|
|
|
|
<td class='docblock-short'>
|
|
|
|
|
|
|
|
|
|
|
|
</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 = "mentat_sql";
|
|
|
|
|
|
</script>
|
|
|
|
|
|
<script src="../main.js"></script>
|
|
|
|
|
|
<script defer src="../search-index.js"></script>
|
|
|
|
|
|
</body>
|
|
|
|
|
|
</html>
|
