148 lines
No EOL
9.6 KiB
HTML
148 lines
No EOL
9.6 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 `QueryBuilder` trait in crate `mentat_sql`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, QueryBuilder">
|
||
|
||
<title>mentat_sql::QueryBuilder - 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 trait">
|
||
<!--[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'>Trait QueryBuilder</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.push_sql">push_sql</a><a href="#tymethod.push_identifier">push_identifier</a><a href="#tymethod.push_typed_value">push_typed_value</a><a href="#tymethod.push_bind_param">push_bind_param</a><a href="#tymethod.finish">finish</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>mentat_sql</a></p><script>window.sidebarCurrent = {name: 'QueryBuilder', ty: 'trait', 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'>Trait <a href='index.html'>mentat_sql</a>::<wbr><a class="trait" href=''>QueryBuilder</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/mentat_sql/lib.rs.html#55-61' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust trait'>pub trait QueryBuilder {
|
||
fn <a href='#tymethod.push_sql' class='fnname'>push_sql</a>(&mut self, sql: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>);
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.push_identifier' class='fnname'>push_identifier</a>(&mut self, identifier: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="type" href="../sql_traits/errors/type.BuildQueryResult.html" title="type sql_traits::errors::BuildQueryResult">BuildQueryResult</a>;
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.push_typed_value' class='fnname'>push_typed_value</a>(&mut self, value: &<a class="enum" href="../core_traits/enum.TypedValue.html" title="enum core_traits::TypedValue">TypedValue</a>) -> <a class="type" href="../sql_traits/errors/type.BuildQueryResult.html" title="type sql_traits::errors::BuildQueryResult">BuildQueryResult</a>;
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.push_bind_param' class='fnname'>push_bind_param</a>(&mut self, name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="type" href="../sql_traits/errors/type.BuildQueryResult.html" title="type sql_traits::errors::BuildQueryResult">BuildQueryResult</a>;
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.finish' class='fnname'>finish</a>(self) -> <a class="struct" href="../mentat_sql/struct.SQLQuery.html" title="struct mentat_sql::SQLQuery">SQLQuery</a>;
|
||
}</pre><div class='docblock'><p>Gratefully based on Diesel's QueryBuilder trait:
|
||
https://github.com/diesel-rs/diesel/blob/4885f61b8205f7f3c2cfa03837ed6714831abe6b/diesel/src/query_builder/mod.rs#L56</p>
|
||
</div>
|
||
<h2 id='required-methods' class='small-section-header'>
|
||
Required Methods<a href='#required-methods' class='anchor'></a>
|
||
</h2>
|
||
<div class='methods'>
|
||
<h3 id='tymethod.push_sql' class='method'><span id='push_sql.v' class='invisible'><code>fn <a href='#tymethod.push_sql' class='fnname'>push_sql</a>(&mut self, sql: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>)</code></span></h3><h3 id='tymethod.push_identifier' class='method'><span id='push_identifier.v' class='invisible'><code>fn <a href='#tymethod.push_identifier' class='fnname'>push_identifier</a>(&mut self, identifier: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="type" href="../sql_traits/errors/type.BuildQueryResult.html" title="type sql_traits::errors::BuildQueryResult">BuildQueryResult</a></code></span></h3><h3 id='tymethod.push_typed_value' class='method'><span id='push_typed_value.v' class='invisible'><code>fn <a href='#tymethod.push_typed_value' class='fnname'>push_typed_value</a>(&mut self, value: &<a class="enum" href="../core_traits/enum.TypedValue.html" title="enum core_traits::TypedValue">TypedValue</a>) -> <a class="type" href="../sql_traits/errors/type.BuildQueryResult.html" title="type sql_traits::errors::BuildQueryResult">BuildQueryResult</a></code></span></h3><h3 id='tymethod.push_bind_param' class='method'><span id='push_bind_param.v' class='invisible'><code>fn <a href='#tymethod.push_bind_param' class='fnname'>push_bind_param</a>(&mut self, name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="type" href="../sql_traits/errors/type.BuildQueryResult.html" title="type sql_traits::errors::BuildQueryResult">BuildQueryResult</a></code></span></h3><h3 id='tymethod.finish' class='method'><span id='finish.v' class='invisible'><code>fn <a href='#tymethod.finish' class='fnname'>finish</a>(self) -> <a class="struct" href="../mentat_sql/struct.SQLQuery.html" title="struct mentat_sql::SQLQuery">SQLQuery</a></code></span></h3></div>
|
||
<h2 id='implementors' class='small-section-header'>
|
||
Implementors<a href='#implementors' class='anchor'></a>
|
||
</h2>
|
||
<ul class='item-list' id='implementors-list'>
|
||
<li><div class='out-of-band'><a class='srclink' href='../src/mentat_sql/lib.rs.html#136-240' title='goto source code'>[src]</a></div><code>impl QueryBuilder for <a class="struct" href="../mentat_sql/struct.SQLiteQueryBuilder.html" title="struct mentat_sql::SQLiteQueryBuilder">SQLiteQueryBuilder</a></code></li>
|
||
</ul><script type="text/javascript" async
|
||
src="../implementors/mentat_sql/trait.QueryBuilder.js">
|
||
</script></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> |