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
140 lines
No EOL
17 KiB
HTML
140 lines
No EOL
17 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` struct in crate `mentat_ffi`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, QueryBuilder">
|
||
|
||
<title>mentat_ffi::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="../light.css" id="themeStyle">
|
||
<script src="../storage.js"></script>
|
||
|
||
|
||
|
||
|
||
</head>
|
||
<body class="rustdoc struct">
|
||
<!--[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'>Struct QueryBuilder</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.bind_value">bind_value</a><a href="#method.bind_ref_from_kw">bind_ref_from_kw</a><a href="#method.bind_ref">bind_ref</a><a href="#method.bind_long">bind_long</a><a href="#method.bind_instant">bind_instant</a><a href="#method.bind_date_time">bind_date_time</a><a href="#method.bind_type">bind_type</a><a href="#method.execute">execute</a><a href="#method.execute_scalar">execute_scalar</a><a href="#method.execute_coll">execute_coll</a><a href="#method.execute_tuple">execute_tuple</a><a href="#method.execute_rel">execute_rel</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">!Send</a><a href="#impl-Sync">!Sync</a></div></div><p class='location'><a href='index.html'>mentat_ffi</a></p><script>window.sidebarCurrent = {name: 'QueryBuilder', ty: 'struct', 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'>Struct <a href='index.html'>mentat_ffi</a>::<wbr><a class="struct" 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></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct QueryBuilder<'a> { /* fields omitted */ }</pre></div>
|
||
<h2 id='methods' class='small-section-header'>
|
||
Methods<a href='#methods' class='anchor'></a>
|
||
</h2>
|
||
<h3 id='impl' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<'a> <a class="struct" href="../mentat_ffi/struct.QueryBuilder.html" title="struct mentat_ffi::QueryBuilder">QueryBuilder</a><'a></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.new' class='fnname'>new</a><T>(store: &'a mut <a class="struct" href="../mentat_ffi/struct.Store.html" title="struct mentat_ffi::Store">Store</a>, query: T) -> <a class="struct" href="../mentat_ffi/struct.QueryBuilder.html" title="struct mentat_ffi::QueryBuilder">QueryBuilder</a><'a> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>, </span></code></td><td></td></tr></tbody></table></span></h4><h4 id='method.bind_value' class="method"><span id='bind_value.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.bind_value' class='fnname'>bind_value</a><T>(&mut self, var: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, value: T) -> &mut <a class="struct" href="../mentat_ffi/struct.QueryBuilder.html" title="struct mentat_ffi::QueryBuilder">QueryBuilder</a><'a> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="../mentat_ffi/enum.TypedValue.html" title="enum mentat_ffi::TypedValue">TypedValue</a>>, </span></code></td><td></td></tr></tbody></table></span></h4><h4 id='method.bind_ref_from_kw' class="method"><span id='bind_ref_from_kw.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.bind_ref_from_kw' class='fnname'>bind_ref_from_kw</a>(<br> &mut self, <br> var: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> value: <a class="struct" href="../edn/symbols/struct.Keyword.html" title="struct edn::symbols::Keyword">Keyword</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><&mut <a class="struct" href="../mentat_ffi/struct.QueryBuilder.html" title="struct mentat_ffi::QueryBuilder">QueryBuilder</a><'a>, Error></code></td><td></td></tr></tbody></table></span></h4><h4 id='method.bind_ref' class="method"><span id='bind_ref.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.bind_ref' class='fnname'>bind_ref</a><T>(&mut self, var: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, value: T) -> &mut <a class="struct" href="../mentat_ffi/struct.QueryBuilder.html" title="struct mentat_ffi::QueryBuilder">QueryBuilder</a><'a> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>>, </span></code></td><td></td></tr></tbody></table></span></h4><h4 id='method.bind_long' class="method"><span id='bind_long.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.bind_long' class='fnname'>bind_long</a>(&mut self, var: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>) -> &mut <a class="struct" href="../mentat_ffi/struct.QueryBuilder.html" title="struct mentat_ffi::QueryBuilder">QueryBuilder</a><'a></code></td><td></td></tr></tbody></table></span></h4><h4 id='method.bind_instant' class="method"><span id='bind_instant.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.bind_instant' class='fnname'>bind_instant</a>(&mut self, var: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>) -> &mut <a class="struct" href="../mentat_ffi/struct.QueryBuilder.html" title="struct mentat_ffi::QueryBuilder">QueryBuilder</a><'a></code></td><td></td></tr></tbody></table></span></h4><h4 id='method.bind_date_time' class="method"><span id='bind_date_time.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.bind_date_time' class='fnname'>bind_date_time</a>(<br> &mut self, <br> var: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> value: <a class="struct" href="https://docs.rs/chrono/0.4.0/chrono/datetime/struct.DateTime.html" title="struct chrono::datetime::DateTime">DateTime</a><<a class="struct" href="https://docs.rs/chrono/0.4.0/chrono/offset/utc/struct.Utc.html" title="struct chrono::offset::utc::Utc">Utc</a>><br>) -> &mut <a class="struct" href="../mentat_ffi/struct.QueryBuilder.html" title="struct mentat_ffi::QueryBuilder">QueryBuilder</a><'a></code></td><td></td></tr></tbody></table></span></h4><h4 id='method.bind_type' class="method"><span id='bind_type.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.bind_type' class='fnname'>bind_type</a>(<br> &mut self, <br> var: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> value_type: <a class="enum" href="../mentat_ffi/enum.ValueType.html" title="enum mentat_ffi::ValueType">ValueType</a><br>) -> &mut <a class="struct" href="../mentat_ffi/struct.QueryBuilder.html" title="struct mentat_ffi::QueryBuilder">QueryBuilder</a><'a></code></td><td></td></tr></tbody></table></span></h4><h4 id='method.execute' class="method"><span id='execute.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.execute' class='fnname'>execute</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../mentat_ffi/struct.QueryOutput.html" title="struct mentat_ffi::QueryOutput">QueryOutput</a>, Error></code></td><td></td></tr></tbody></table></span></h4><h4 id='method.execute_scalar' class="method"><span id='execute_scalar.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.execute_scalar' class='fnname'>execute_scalar</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="../mentat_ffi/enum.Binding.html" title="enum mentat_ffi::Binding">Binding</a>>, Error></code></td><td></td></tr></tbody></table></span></h4><h4 id='method.execute_coll' class="method"><span id='execute_coll.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.execute_coll' class='fnname'>execute_coll</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="enum" href="../mentat_ffi/enum.Binding.html" title="enum mentat_ffi::Binding">Binding</a>>, Error></code></td><td></td></tr></tbody></table></span></h4><h4 id='method.execute_tuple' class="method"><span id='execute_tuple.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.execute_tuple' class='fnname'>execute_tuple</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="enum" href="../mentat_ffi/enum.Binding.html" title="enum mentat_ffi::Binding">Binding</a>>>, Error></code></td><td></td></tr></tbody></table></span></h4><h4 id='method.execute_rel' class="method"><span id='execute_rel.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.execute_rel' class='fnname'>execute_rel</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../mentat_ffi/struct.RelResult.html" title="struct mentat_ffi::RelResult">RelResult</a><<a class="enum" href="../mentat_ffi/enum.Binding.html" title="enum mentat_ffi::Binding">Binding</a>>, Error></code></td><td></td></tr></tbody></table></span></h4></div>
|
||
<h2 id='implementations' class='small-section-header'>
|
||
Trait Implementations<a href='#implementations' class='anchor'></a>
|
||
</h2>
|
||
<div id='implementations-list'>
|
||
</div>
|
||
<h2 id='synthetic-implementations' class='small-section-header'>
|
||
Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a>
|
||
</h2>
|
||
<div id='synthetic-implementations-list'>
|
||
<h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<'a> !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../mentat_ffi/struct.QueryBuilder.html" title="struct mentat_ffi::QueryBuilder">QueryBuilder</a><'a></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<'a> !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../mentat_ffi/struct.QueryBuilder.html" title="struct mentat_ffi::QueryBuilder">QueryBuilder</a><'a></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></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 = "mentat_ffi";
|
||
</script>
|
||
<script src="../main.js"></script>
|
||
<script defer src="../search-index.js"></script>
|
||
</body>
|
||
</html> |