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
187 lines
No EOL
20 KiB
HTML
187 lines
No EOL
20 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 `Constraint` enum in crate `mentat_query_sql`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, Constraint">
|
||
|
||
<title>mentat_query_sql::Constraint - 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 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">☰</div>
|
||
|
||
<p class='location'>Enum Constraint</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#variants">Variants</a><div class="sidebar-links"><a href="#variant.Infix">Infix</a><a href="#variant.Or">Or</a><a href="#variant.And">And</a><a href="#variant.In">In</a><a href="#variant.IsNull">IsNull</a><a href="#variant.IsNotNull">IsNotNull</a><a href="#variant.NotExists">NotExists</a><a href="#variant.TypeCheck">TypeCheck</a></div><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.not_equal">not_equal</a><a href="#method.equal">equal</a><a href="#method.fulltext_match">fulltext_match</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-QueryFragment">QueryFragment</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_query_sql</a></p><script>window.sidebarCurrent = {name: 'Constraint', 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'>mentat_query_sql</a>::<wbr><a class="enum" href=''>Constraint</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_query_sql/lib.rs.html#121-150' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust enum'>pub enum Constraint {
|
||
Infix {
|
||
op: <a class="struct" href="../mentat_query_sql/struct.Op.html" title="struct mentat_query_sql::Op">Op</a>,
|
||
left: <a class="enum" href="../mentat_query_sql/enum.ColumnOrExpression.html" title="enum mentat_query_sql::ColumnOrExpression">ColumnOrExpression</a>,
|
||
right: <a class="enum" href="../mentat_query_sql/enum.ColumnOrExpression.html" title="enum mentat_query_sql::ColumnOrExpression">ColumnOrExpression</a>,
|
||
},
|
||
Or {
|
||
constraints: <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_query_sql/enum.Constraint.html" title="enum mentat_query_sql::Constraint">Constraint</a>>,
|
||
},
|
||
And {
|
||
constraints: <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_query_sql/enum.Constraint.html" title="enum mentat_query_sql::Constraint">Constraint</a>>,
|
||
},
|
||
In {
|
||
left: <a class="enum" href="../mentat_query_sql/enum.ColumnOrExpression.html" title="enum mentat_query_sql::ColumnOrExpression">ColumnOrExpression</a>,
|
||
list: <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_query_sql/enum.ColumnOrExpression.html" title="enum mentat_query_sql::ColumnOrExpression">ColumnOrExpression</a>>,
|
||
},
|
||
IsNull {
|
||
value: <a class="enum" href="../mentat_query_sql/enum.ColumnOrExpression.html" title="enum mentat_query_sql::ColumnOrExpression">ColumnOrExpression</a>,
|
||
},
|
||
IsNotNull {
|
||
value: <a class="enum" href="../mentat_query_sql/enum.ColumnOrExpression.html" title="enum mentat_query_sql::ColumnOrExpression">ColumnOrExpression</a>,
|
||
},
|
||
NotExists {
|
||
subquery: <a class="enum" href="../mentat_query_sql/enum.TableOrSubquery.html" title="enum mentat_query_sql::TableOrSubquery">TableOrSubquery</a>,
|
||
},
|
||
TypeCheck {
|
||
value: <a class="enum" href="../mentat_query_sql/enum.ColumnOrExpression.html" title="enum mentat_query_sql::ColumnOrExpression">ColumnOrExpression</a>,
|
||
affinity: SQLTypeAffinity,
|
||
},
|
||
}</pre></div><h2 id='variants' class='variants small-section-header'>
|
||
Variants<a href='#variants' class='anchor'></a></h2>
|
||
<span id="variant.Infix" class="variant small-section-header"><a href="#variant.Infix" class="anchor field"></a><span id='Infix.v' class='invisible'><code>Infix</code></span></span><span class='docblock autohide sub-variant' id='variant.Infix.fields'><h3 class='fields'>Fields of <code>Infix</code></h3>
|
||
|
||
<table><tr><td id='variant.Infix.field.op'><span id='Infix.v.op.v' class='invisible'><code>op: <a class="struct" href="../mentat_query_sql/struct.Op.html" title="struct mentat_query_sql::Op">Op</a></code></span></td><td></td></tr><tr><td id='variant.Infix.field.left'><span id='Infix.v.left.v' class='invisible'><code>left: <a class="enum" href="../mentat_query_sql/enum.ColumnOrExpression.html" title="enum mentat_query_sql::ColumnOrExpression">ColumnOrExpression</a></code></span></td><td></td></tr><tr><td id='variant.Infix.field.right'><span id='Infix.v.right.v' class='invisible'><code>right: <a class="enum" href="../mentat_query_sql/enum.ColumnOrExpression.html" title="enum mentat_query_sql::ColumnOrExpression">ColumnOrExpression</a></code></span></td><td></td></tr></table></span><span id="variant.Or" class="variant small-section-header"><a href="#variant.Or" class="anchor field"></a><span id='Or.v' class='invisible'><code>Or</code></span></span><span class='docblock autohide sub-variant' id='variant.Or.fields'><h3 class='fields'>Fields of <code>Or</code></h3>
|
||
|
||
<table><tr><td id='variant.Or.field.constraints'><span id='Or.v.constraints.v' class='invisible'><code>constraints: <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_query_sql/enum.Constraint.html" title="enum mentat_query_sql::Constraint">Constraint</a>></code></span></td><td></td></tr></table></span><span id="variant.And" class="variant small-section-header"><a href="#variant.And" class="anchor field"></a><span id='And.v' class='invisible'><code>And</code></span></span><span class='docblock autohide sub-variant' id='variant.And.fields'><h3 class='fields'>Fields of <code>And</code></h3>
|
||
|
||
<table><tr><td id='variant.And.field.constraints'><span id='And.v.constraints.v' class='invisible'><code>constraints: <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_query_sql/enum.Constraint.html" title="enum mentat_query_sql::Constraint">Constraint</a>></code></span></td><td></td></tr></table></span><span id="variant.In" class="variant small-section-header"><a href="#variant.In" class="anchor field"></a><span id='In.v' class='invisible'><code>In</code></span></span><span class='docblock autohide sub-variant' id='variant.In.fields'><h3 class='fields'>Fields of <code>In</code></h3>
|
||
|
||
<table><tr><td id='variant.In.field.left'><span id='In.v.left.v' class='invisible'><code>left: <a class="enum" href="../mentat_query_sql/enum.ColumnOrExpression.html" title="enum mentat_query_sql::ColumnOrExpression">ColumnOrExpression</a></code></span></td><td></td></tr><tr><td id='variant.In.field.list'><span id='In.v.list.v' class='invisible'><code>list: <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_query_sql/enum.ColumnOrExpression.html" title="enum mentat_query_sql::ColumnOrExpression">ColumnOrExpression</a>></code></span></td><td></td></tr></table></span><span id="variant.IsNull" class="variant small-section-header"><a href="#variant.IsNull" class="anchor field"></a><span id='IsNull.v' class='invisible'><code>IsNull</code></span></span><span class='docblock autohide sub-variant' id='variant.IsNull.fields'><h3 class='fields'>Fields of <code>IsNull</code></h3>
|
||
|
||
<table><tr><td id='variant.IsNull.field.value'><span id='IsNull.v.value.v' class='invisible'><code>value: <a class="enum" href="../mentat_query_sql/enum.ColumnOrExpression.html" title="enum mentat_query_sql::ColumnOrExpression">ColumnOrExpression</a></code></span></td><td></td></tr></table></span><span id="variant.IsNotNull" class="variant small-section-header"><a href="#variant.IsNotNull" class="anchor field"></a><span id='IsNotNull.v' class='invisible'><code>IsNotNull</code></span></span><span class='docblock autohide sub-variant' id='variant.IsNotNull.fields'><h3 class='fields'>Fields of <code>IsNotNull</code></h3>
|
||
|
||
<table><tr><td id='variant.IsNotNull.field.value'><span id='IsNotNull.v.value.v' class='invisible'><code>value: <a class="enum" href="../mentat_query_sql/enum.ColumnOrExpression.html" title="enum mentat_query_sql::ColumnOrExpression">ColumnOrExpression</a></code></span></td><td></td></tr></table></span><span id="variant.NotExists" class="variant small-section-header"><a href="#variant.NotExists" class="anchor field"></a><span id='NotExists.v' class='invisible'><code>NotExists</code></span></span><span class='docblock autohide sub-variant' id='variant.NotExists.fields'><h3 class='fields'>Fields of <code>NotExists</code></h3>
|
||
|
||
<table><tr><td id='variant.NotExists.field.subquery'><span id='NotExists.v.subquery.v' class='invisible'><code>subquery: <a class="enum" href="../mentat_query_sql/enum.TableOrSubquery.html" title="enum mentat_query_sql::TableOrSubquery">TableOrSubquery</a></code></span></td><td></td></tr></table></span><span id="variant.TypeCheck" class="variant small-section-header"><a href="#variant.TypeCheck" class="anchor field"></a><span id='TypeCheck.v' class='invisible'><code>TypeCheck</code></span></span><span class='docblock autohide sub-variant' id='variant.TypeCheck.fields'><h3 class='fields'>Fields of <code>TypeCheck</code></h3>
|
||
|
||
<table><tr><td id='variant.TypeCheck.field.value'><span id='TypeCheck.v.value.v' class='invisible'><code>value: <a class="enum" href="../mentat_query_sql/enum.ColumnOrExpression.html" title="enum mentat_query_sql::ColumnOrExpression">ColumnOrExpression</a></code></span></td><td></td></tr><tr><td id='variant.TypeCheck.field.affinity'><span id='TypeCheck.v.affinity.v' class='invisible'><code>affinity: SQLTypeAffinity</code></span></td><td></td></tr></table></span>
|
||
<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 class="enum" href="../mentat_query_sql/enum.Constraint.html" title="enum mentat_query_sql::Constraint">Constraint</a></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_sql/lib.rs.html#152-176' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.not_equal' class="method"><span id='not_equal.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.not_equal' class='fnname'>not_equal</a>(<br> left: <a class="enum" href="../mentat_query_sql/enum.ColumnOrExpression.html" title="enum mentat_query_sql::ColumnOrExpression">ColumnOrExpression</a>, <br> right: <a class="enum" href="../mentat_query_sql/enum.ColumnOrExpression.html" title="enum mentat_query_sql::ColumnOrExpression">ColumnOrExpression</a><br>) -> <a class="enum" href="../mentat_query_sql/enum.Constraint.html" title="enum mentat_query_sql::Constraint">Constraint</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_sql/lib.rs.html#153-159' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.equal' class="method"><span id='equal.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.equal' class='fnname'>equal</a>(left: <a class="enum" href="../mentat_query_sql/enum.ColumnOrExpression.html" title="enum mentat_query_sql::ColumnOrExpression">ColumnOrExpression</a>, right: <a class="enum" href="../mentat_query_sql/enum.ColumnOrExpression.html" title="enum mentat_query_sql::ColumnOrExpression">ColumnOrExpression</a>) -> <a class="enum" href="../mentat_query_sql/enum.Constraint.html" title="enum mentat_query_sql::Constraint">Constraint</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_sql/lib.rs.html#161-167' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.fulltext_match' class="method"><span id='fulltext_match.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.fulltext_match' class='fnname'>fulltext_match</a>(<br> left: <a class="enum" href="../mentat_query_sql/enum.ColumnOrExpression.html" title="enum mentat_query_sql::ColumnOrExpression">ColumnOrExpression</a>, <br> right: <a class="enum" href="../mentat_query_sql/enum.ColumnOrExpression.html" title="enum mentat_query_sql::ColumnOrExpression">ColumnOrExpression</a><br>) -> <a class="enum" href="../mentat_query_sql/enum.Constraint.html" title="enum mentat_query_sql::Constraint">Constraint</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_sql/lib.rs.html#169-175' title='goto source code'>[src]</a></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'>
|
||
<h3 id='impl-QueryFragment' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl QueryFragment for <a class="enum" href="../mentat_query_sql/enum.Constraint.html" title="enum mentat_query_sql::Constraint">Constraint</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_query_sql/lib.rs.html#345-425' 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' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.push_sql' class='fnname'>push_sql</a>(&self, out: &mut QueryBuilder) -> BuildQueryResult</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_sql/lib.rs.html#346-424' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4></div></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 class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="enum" href="../mentat_query_sql/enum.Constraint.html" title="enum mentat_query_sql::Constraint">Constraint</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 class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="enum" href="../mentat_query_sql/enum.Constraint.html" title="enum mentat_query_sql::Constraint">Constraint</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_query_sql";
|
||
</script>
|
||
<script src="../main.js"></script>
|
||
<script defer src="../search-index.js"></script>
|
||
</body>
|
||
</html> |