c5180656cc
Steps to building docs locally:
1. Install Jekyll
2. cd docs
3. bundle exec jekyll serve --incremental
4. open local docs site at http://127.0.0.1:4000/
* basic Jekyll site
* Add docs to documentation site
* Update javadoc to allow for error free builds
* Remove docs for rust dependencies
* Better display examples, about and contributing documentation for Mentat
* Version docs
150 lines
No EOL
12 KiB
HTML
150 lines
No EOL
12 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 `QueryFragment` trait in crate `mentat_sql`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, QueryFragment">
|
||
|
||
<title>mentat_sql::QueryFragment - 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 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 QueryFragment</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></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-QueryFragment">Box<QueryFragment></a><a href="#impl-QueryFragment">()</a></div><a class="sidebar-title" href="#implementors">Implementors</a><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-QueryFragment">QueryFragment</a></div></div><p class='location'><a href='index.html'>mentat_sql</a></p><script>window.sidebarCurrent = {name: 'QueryFragment', 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=''>QueryFragment</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#64-66' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust trait'>pub trait QueryFragment {
|
||
fn <a href='#tymethod.push_sql' class='fnname'>push_sql</a>(&self, out: &mut <a class="trait" href="../mentat_sql/trait.QueryBuilder.html" title="trait mentat_sql::QueryBuilder">QueryBuilder</a>) -> <a class="type" href="../mentat_sql/type.BuildQueryResult.html" title="type mentat_sql::BuildQueryResult">BuildQueryResult</a>;
|
||
}</pre></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>(&self, out: &mut <a class="trait" href="../mentat_sql/trait.QueryBuilder.html" title="trait mentat_sql::QueryBuilder">QueryBuilder</a>) -> <a class="type" href="../mentat_sql/type.BuildQueryResult.html" title="type mentat_sql::BuildQueryResult">BuildQueryResult</a></code></span></h3></div>
|
||
<h2 id='implementations' class='small-section-header'>
|
||
Trait Implementations<a href='#implementations' class='anchor'></a>
|
||
</h2>
|
||
<div id='implementations-list'>
|
||
<h3 id='impl-QueryFragment' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<'a> <a class="trait" href="../mentat_sql/trait.QueryFragment.html" title="trait mentat_sql::QueryFragment">QueryFragment</a> for &'a <a class="trait" href="../mentat_sql/trait.QueryFragment.html" title="trait mentat_sql::QueryFragment">QueryFragment</a></code><a href='#impl-QueryFragment' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_sql/lib.rs.html#74-78' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.push_sql' class="method"><span id='push_sql.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../mentat_sql/trait.QueryFragment.html#tymethod.push_sql' class='fnname'>push_sql</a>(&self, out: &mut <a class="trait" href="../mentat_sql/trait.QueryBuilder.html" title="trait mentat_sql::QueryBuilder">QueryBuilder</a>) -> <a class="type" href="../mentat_sql/type.BuildQueryResult.html" title="type mentat_sql::BuildQueryResult">BuildQueryResult</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_sql/lib.rs.html#75-77' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4></div></div>
|
||
<h2 id='foreign-impls' class='small-section-header'>
|
||
Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a>
|
||
</h2>
|
||
<h3 id='impl-QueryFragment-1' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../mentat_sql/trait.QueryFragment.html" title="trait mentat_sql::QueryFragment">QueryFragment</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><<a class="trait" href="../mentat_sql/trait.QueryFragment.html" title="trait mentat_sql::QueryFragment">QueryFragment</a>></code><a href='#impl-QueryFragment-1' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_sql/lib.rs.html#68-72' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><span class='docblock autohide'><div class='impl-items'><h4 id='method.push_sql-1' class="method"><span id='push_sql.v-2' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.push_sql' class='fnname'>push_sql</a>(&self, out: &mut <a class="trait" href="../mentat_sql/trait.QueryBuilder.html" title="trait mentat_sql::QueryBuilder">QueryBuilder</a>) -> <a class="type" href="../mentat_sql/type.BuildQueryResult.html" title="type mentat_sql::BuildQueryResult">BuildQueryResult</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_sql/lib.rs.html#69-71' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4></div></span><h3 id='impl-QueryFragment-2' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../mentat_sql/trait.QueryFragment.html" title="trait mentat_sql::QueryFragment">QueryFragment</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a></code><a href='#impl-QueryFragment-2' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_sql/lib.rs.html#80-84' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><span class='docblock autohide'><div class='impl-items'><h4 id='method.push_sql-2' class="method"><span id='push_sql.v-3' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.push_sql' class='fnname'>push_sql</a>(&self, _out: &mut <a class="trait" href="../mentat_sql/trait.QueryBuilder.html" title="trait mentat_sql::QueryBuilder">QueryBuilder</a>) -> <a class="type" href="../mentat_sql/type.BuildQueryResult.html" title="type mentat_sql::BuildQueryResult">BuildQueryResult</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_sql/lib.rs.html#81-83' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4></div></span>
|
||
<h2 id='implementors' class='small-section-header'>
|
||
Implementors<a href='#implementors' class='anchor'></a>
|
||
</h2>
|
||
<ul class='item-list' id='implementors-list'>
|
||
<li><table class='table-display'><tbody><tr><td><code>impl<'a> QueryFragment for &'a <a class="trait" href="../mentat_sql/trait.QueryFragment.html" title="trait mentat_sql::QueryFragment">QueryFragment</a></code><td><div class='out-of-band'><a class='srclink' href='../src/mentat_sql/lib.rs.html#74-78' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
|
||
</ul><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
|
||
src="../implementors/mentat_sql/trait.QueryFragment.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> |