greg/mentat
1
0
Fork 0
Code Issues 294 Pull requests Projects Releases 9 Packages Wiki Activity
mentat/docs/apis/0.7/rust/mentat_query_algebrizer/struct.ConjoiningClauses.html

238 lines
33 KiB
HTML
Raw Normal View History

Mentat documentation website using Jekyll (#754) 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
2018-06-25 10:20:36 +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 `ConjoiningClauses` struct in crate `mentat_query_algebrizer`.">
<meta name="keywords" content="rust, rustlang, rust-lang, ConjoiningClauses">
<title>mentat_query_algebrizer::ConjoiningClauses - 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">&#9776;</div>
<p class='location'>Struct ConjoiningClauses</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#fields">Fields</a><div class="sidebar-links"><a href="#structfield.empty_because">empty_because</a><a href="#structfield.from">from</a><a href="#structfield.computed_tables">computed_tables</a><a href="#structfield.wheres">wheres</a><a href="#structfield.column_bindings">column_bindings</a><a href="#structfield.input_variables">input_variables</a><a href="#structfield.known_types">known_types</a><a href="#structfield.extracted_types">extracted_types</a></div><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.bind_value">bind_value</a><a href="#method.bound_value">bound_value</a><a href="#method.is_value_bound">is_value_bound</a><a href="#method.value_bindings">value_bindings</a><a href="#method.value_bound_variables">value_bound_variables</a><a href="#method.value_bound_variable_set">value_bound_variable_set</a><a href="#method.known_type">known_type</a><a href="#method.known_type_set">known_type_set</a><a href="#method.is_known_empty">is_known_empty</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-PartialEq">PartialEq</a><a href="#impl-Eq">Eq</a><a href="#impl-Debug">Debug</a><a href="#impl-Default">Default</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_algebrizer</a></p><script>window.sidebarCurrent = {name: 'ConjoiningClauses', 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_query_algebrizer</a>::<wbr><a class="struct" href=''>ConjoiningClauses</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'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../src/mentat_query_algebrizer/clauses/mod.rs.html#177-226' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct ConjoiningClauses {
pub empty_because: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="enum" href="../mentat_query_algebrizer/enum.EmptyBecause.html" title="enum mentat_query_algebrizer::EmptyBecause">EmptyBecause</a>&gt;,
pub from: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="../mentat_query_algebrizer/struct.SourceAlias.html" title="struct mentat_query_algebrizer::SourceAlias">SourceAlias</a>&gt;,
pub computed_tables: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="enum" href="../mentat_query_algebrizer/enum.ComputedTable.html" title="enum mentat_query_algebrizer::ComputedTable">ComputedTable</a>&gt;,
pub wheres: <a class="struct" href="../mentat_query_algebrizer/struct.ColumnIntersection.html" title="struct mentat_query_algebrizer::ColumnIntersection">ColumnIntersection</a>,
Fix broken documentation links. (#775) (#767) r=nalexander * Fix broken API doc links Create symlink for latest to point to v0.7. Group APIs by top version number rather than individual * Update swift and android version numbers to match Mentats * Update documentation * Update top level .gitignore to ignore docs site & metatdata * Add README to help with building documentation site * Address review comments @ncalexan
2018-06-29 17:28:44 +00:00
pub column_bindings: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/btree/map/struct.BTreeMap.html" title="struct alloc::btree::map::BTreeMap">BTreeMap</a>&lt;<a class="struct" href="../edn/query/struct.Variable.html" title="struct edn::query::Variable">Variable</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="../mentat_query_algebrizer/struct.QualifiedAlias.html" title="struct mentat_query_algebrizer::QualifiedAlias">QualifiedAlias</a>&gt;&gt;,
pub input_variables: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/btree/set/struct.BTreeSet.html" title="struct alloc::btree::set::BTreeSet">BTreeSet</a>&lt;<a class="struct" href="../edn/query/struct.Variable.html" title="struct edn::query::Variable">Variable</a>&gt;,
pub known_types: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/btree/map/struct.BTreeMap.html" title="struct alloc::btree::map::BTreeMap">BTreeMap</a>&lt;<a class="struct" href="../edn/query/struct.Variable.html" title="struct edn::query::Variable">Variable</a>, <a class="struct" href="../mentat_core/value_type_set/struct.ValueTypeSet.html" title="struct mentat_core::value_type_set::ValueTypeSet">ValueTypeSet</a>&gt;,
pub extracted_types: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/btree/map/struct.BTreeMap.html" title="struct alloc::btree::map::BTreeMap">BTreeMap</a>&lt;<a class="struct" href="../edn/query/struct.Variable.html" title="struct edn::query::Variable">Variable</a>, <a class="struct" href="../mentat_query_algebrizer/struct.QualifiedAlias.html" title="struct mentat_query_algebrizer::QualifiedAlias">QualifiedAlias</a>&gt;,
Mentat documentation website using Jekyll (#754) 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
2018-06-25 10:20:36 +00:00
// some fields omitted
}</pre></div><div class='docblock'><p>A <code>ConjoiningClauses</code> (CC) is a collection of clauses that are combined with <code>JOIN</code>.
The topmost form in a query is a <code>ConjoiningClauses</code>.</p>
<ul>
<li>Ordinary pattern clauses turn into <code>FROM</code> parts and <code>WHERE</code> parts using <code>=</code>.</li>
<li>Predicate clauses turn into the same, but with other functions.</li>
<li>Function clauses turn into <code>WHERE</code> parts using function-specific comparisons.</li>
<li><code>not</code> turns into <code>NOT EXISTS</code> with <code>WHERE</code> clauses inside the subquery to
bind it to the outer variables, or adds simple <code>WHERE</code> clauses to the outer
clause.</li>
<li><code>not-join</code> is similar, but with explicit binding.</li>
<li><code>or</code> turns into a collection of <code>UNION</code>s inside a subquery, or a simple
alternation.
<code>or</code>'s documentation states that all clauses must include the same vars,
but that's an over-simplification: all clauses must refer to the external
unification vars.
The entire <code>UNION</code>-set is <code>JOIN</code>ed to any surrounding expressions per the <code>rule-vars</code>
clause, or the intersection of the vars in the two sides of the <code>JOIN</code>.</li>
</ul>
<p>Not yet done:</p>
<ul>
<li>Function clauses with bindings turn into:
<ul>
<li>Subqueries. Perhaps less efficient? Certainly clearer.</li>
<li>Projection expressions, if only used for output.</li>
<li>Inline expressions?</li>
</ul>
</li>
</ul>
<hr />
</div><h2 id='fields' class='fields small-section-header'>
Fields<a href='#fields' class='anchor'></a></h2><span id="structfield.empty_because" class="structfield small-section-header">
<a href="#structfield.empty_because" class="anchor field"></a>
<span id="empty_because.v" class='invisible'>
<code>empty_because: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="enum" href="../mentat_query_algebrizer/enum.EmptyBecause.html" title="enum mentat_query_algebrizer::EmptyBecause">EmptyBecause</a>&gt;</code>
</span></span><div class='docblock'><p><code>Some</code> if this set of clauses cannot yield results in the context of the current schema.</p>
</div><span id="structfield.from" class="structfield small-section-header">
<a href="#structfield.from" class="anchor field"></a>
<span id="from.v" class='invisible'>
<code>from: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="../mentat_query_algebrizer/struct.SourceAlias.html" title="struct mentat_query_algebrizer::SourceAlias">SourceAlias</a>&gt;</code>
</span></span><div class='docblock'><p>A vector of source/alias pairs used to construct a SQL <code>FROM</code> list.</p>
</div><span id="structfield.computed_tables" class="structfield small-section-header">
<a href="#structfield.computed_tables" class="anchor field"></a>
<span id="computed_tables.v" class='invisible'>
<code>computed_tables: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="enum" href="../mentat_query_algebrizer/enum.ComputedTable.html" title="enum mentat_query_algebrizer::ComputedTable">ComputedTable</a>&gt;</code>
</span></span><div class='docblock'><p>A vector of computed tables (typically subqueries). The index into this vector is used as
an identifier in a <code>DatomsTable::Computed(c)</code> table reference.</p>
</div><span id="structfield.wheres" class="structfield small-section-header">
<a href="#structfield.wheres" class="anchor field"></a>
<span id="wheres.v" class='invisible'>
<code>wheres: <a class="struct" href="../mentat_query_algebrizer/struct.ColumnIntersection.html" title="struct mentat_query_algebrizer::ColumnIntersection">ColumnIntersection</a></code>
</span></span><div class='docblock'><p>A list of fragments that can be joined by <code>AND</code>.</p>
</div><span id="structfield.column_bindings" class="structfield small-section-header">
<a href="#structfield.column_bindings" class="anchor field"></a>
<span id="column_bindings.v" class='invisible'>
Fix broken documentation links. (#775) (#767) r=nalexander * Fix broken API doc links Create symlink for latest to point to v0.7. Group APIs by top version number rather than individual * Update swift and android version numbers to match Mentats * Update documentation * Update top level .gitignore to ignore docs site & metatdata * Add README to help with building documentation site * Address review comments @ncalexan
2018-06-29 17:28:44 +00:00
<code>column_bindings: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/btree/map/struct.BTreeMap.html" title="struct alloc::btree::map::BTreeMap">BTreeMap</a>&lt;<a class="struct" href="../edn/query/struct.Variable.html" title="struct edn::query::Variable">Variable</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="../mentat_query_algebrizer/struct.QualifiedAlias.html" title="struct mentat_query_algebrizer::QualifiedAlias">QualifiedAlias</a>&gt;&gt;</code>
Mentat documentation website using Jekyll (#754) 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
2018-06-25 10:20:36 +00:00
</span></span><div class='docblock'><p>A map from var to qualified columns. Used to project.</p>
</div><span id="structfield.input_variables" class="structfield small-section-header">
<a href="#structfield.input_variables" class="anchor field"></a>
<span id="input_variables.v" class='invisible'>
Fix broken documentation links. (#775) (#767) r=nalexander * Fix broken API doc links Create symlink for latest to point to v0.7. Group APIs by top version number rather than individual * Update swift and android version numbers to match Mentats * Update documentation * Update top level .gitignore to ignore docs site & metatdata * Add README to help with building documentation site * Address review comments @ncalexan
2018-06-29 17:28:44 +00:00
<code>input_variables: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/btree/set/struct.BTreeSet.html" title="struct alloc::btree::set::BTreeSet">BTreeSet</a>&lt;<a class="struct" href="../edn/query/struct.Variable.html" title="struct edn::query::Variable">Variable</a>&gt;</code>
Mentat documentation website using Jekyll (#754) 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
2018-06-25 10:20:36 +00:00
</span></span><div class='docblock'><p>A list of variables mentioned in the enclosing query's :in clause. These must all be bound
before the query can be executed. TODO: clarify what this means for nested CCs.</p>
</div><span id="structfield.known_types" class="structfield small-section-header">
<a href="#structfield.known_types" class="anchor field"></a>
<span id="known_types.v" class='invisible'>
Fix broken documentation links. (#775) (#767) r=nalexander * Fix broken API doc links Create symlink for latest to point to v0.7. Group APIs by top version number rather than individual * Update swift and android version numbers to match Mentats * Update documentation * Update top level .gitignore to ignore docs site & metatdata * Add README to help with building documentation site * Address review comments @ncalexan
2018-06-29 17:28:44 +00:00
<code>known_types: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/btree/map/struct.BTreeMap.html" title="struct alloc::btree::map::BTreeMap">BTreeMap</a>&lt;<a class="struct" href="../edn/query/struct.Variable.html" title="struct edn::query::Variable">Variable</a>, <a class="struct" href="../mentat_core/value_type_set/struct.ValueTypeSet.html" title="struct mentat_core::value_type_set::ValueTypeSet">ValueTypeSet</a>&gt;</code>
Mentat documentation website using Jekyll (#754) 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
2018-06-25 10:20:36 +00:00
</span></span><div class='docblock'><p>A map from var to type. Whenever a var maps unambiguously to two different types, it cannot
yield results, so we don't represent that case here. If a var isn't present in the map, it
means that its type is not known in advance.
Usually that state should be represented by <code>ValueTypeSet::Any</code>.</p>
</div><span id="structfield.extracted_types" class="structfield small-section-header">
<a href="#structfield.extracted_types" class="anchor field"></a>
<span id="extracted_types.v" class='invisible'>
Fix broken documentation links. (#775) (#767) r=nalexander * Fix broken API doc links Create symlink for latest to point to v0.7. Group APIs by top version number rather than individual * Update swift and android version numbers to match Mentats * Update documentation * Update top level .gitignore to ignore docs site & metatdata * Add README to help with building documentation site * Address review comments @ncalexan
2018-06-29 17:28:44 +00:00
<code>extracted_types: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/btree/map/struct.BTreeMap.html" title="struct alloc::btree::map::BTreeMap">BTreeMap</a>&lt;<a class="struct" href="../edn/query/struct.Variable.html" title="struct edn::query::Variable">Variable</a>, <a class="struct" href="../mentat_query_algebrizer/struct.QualifiedAlias.html" title="struct mentat_query_algebrizer::QualifiedAlias">QualifiedAlias</a>&gt;</code>
Mentat documentation website using Jekyll (#754) 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
2018-06-25 10:20:36 +00:00
</span></span><div class='docblock'><p>A mapping, similar to <code>column_bindings</code>, but used to pull type tags out of the store at runtime.
If a var isn't unit in <code>known_types</code>, it should be present here.</p>
</div>
<h2 id='methods' class='small-section-header'>
Methods<a href='#methods' class='anchor'></a>
</h2>
Fix broken documentation links. (#775) (#767) r=nalexander * Fix broken API doc links Create symlink for latest to point to v0.7. Group APIs by top version number rather than individual * Update swift and android version numbers to match Mentats * Update documentation * Update top level .gitignore to ignore docs site & metatdata * Add README to help with building documentation site * Address review comments @ncalexan
2018-06-29 17:28:44 +00:00
<h3 id='impl' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="struct" href="../mentat_query_algebrizer/struct.ConjoiningClauses.html" title="struct mentat_query_algebrizer::ConjoiningClauses">ConjoiningClauses</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_algebrizer/clauses/mod.rs.html#384-907' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><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>(&amp;mut self, var: &amp;<a class="struct" href="../edn/query/struct.Variable.html" title="struct edn::query::Variable">Variable</a>, value: <a class="enum" href="../mentat_core/types/enum.TypedValue.html" title="enum mentat_core::types::TypedValue">TypedValue</a>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_algebrizer/clauses/mod.rs.html#386-406' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Be careful with this. It'll overwrite existing bindings.</p>
</div><h4 id='method.bound_value' class="method"><span id='bound_value.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.bound_value' class='fnname'>bound_value</a>(&amp;self, var: &amp;<a class="struct" href="../edn/query/struct.Variable.html" title="struct edn::query::Variable">Variable</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="enum" href="../mentat_core/types/enum.TypedValue.html" title="enum mentat_core::types::TypedValue">TypedValue</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_algebrizer/clauses/mod.rs.html#408-410' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.is_value_bound' class="method"><span id='is_value_bound.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.is_value_bound' class='fnname'>is_value_bound</a>(&amp;self, var: &amp;<a class="struct" href="../edn/query/struct.Variable.html" title="struct edn::query::Variable">Variable</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_algebrizer/clauses/mod.rs.html#412-414' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.value_bindings' class="method"><span id='value_bindings.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.value_bindings' class='fnname'>value_bindings</a>(&amp;self, variables: &amp;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/btree/set/struct.BTreeSet.html" title="struct alloc::btree::set::BTreeSet">BTreeSet</a>&lt;<a class="struct" href="../edn/query/struct.Variable.html" title="struct edn::query::Variable">Variable</a>&gt;) -&gt; <a class="type" href="../mentat_query_algebrizer/type.VariableBindings.html" title="type mentat_query_algebrizer::VariableBindings">VariableBindings</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_algebrizer/clauses/mod.rs.html#416-418' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.value_bound_variables' class="method"><span id='value_bound_variables.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.value_bound_variables' class='fnname'>value_bound_variables</a>(&amp;self) -&gt; VariableIterator</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_algebrizer/clauses/mod.rs.html#421-423' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Return an iterator over the variables externally bound to values.</p>
</div><h4 id='method.value_bound_variable_set' class="method"><span id='value_bound_variable_set.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.value_bound_variable_set' class='fnname'>value_bound_variable_set</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/btree/set/struct.BTreeSet.html" title="struct alloc::btree::set::BTreeSet">BTreeSet</a>&lt;<a class="struct" href="../edn/query/struct.Variable.html" title="struct edn::query::Variable">Variable</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_algebrizer/clauses/mod.rs.html#426-428' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Return a set of the variables externally bound to values.</p>
</div><h4 id='method.known_type' class="method"><span id='known_type.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.known_type' class='fnname'>known_type</a>(&amp;self, var: &amp;<a class="struct" href="../edn/query/struct.Variable.html" title="struct edn::query::Variable">Variable</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="enum" href="../mentat_core/types/enum.ValueType.html" title="enum mentat_core::types::ValueType">ValueType</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_algebrizer/clauses/mod.rs.html#434-439' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Return a single <code>ValueType</code> if the given variable is known to have a precise type.
Mentat documentation website using Jekyll (#754) 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
2018-06-25 10:20:36 +00:00
Returns <code>None</code> if the type of the variable is unknown.
Returns <code>None</code> if the type of the variable is known but not precise -- &quot;double
or integer&quot; isn't good enough.</p>
Fix broken documentation links. (#775) (#767) r=nalexander * Fix broken API doc links Create symlink for latest to point to v0.7. Group APIs by top version number rather than individual * Update swift and android version numbers to match Mentats * Update documentation * Update top level .gitignore to ignore docs site & metatdata * Add README to help with building documentation site * Address review comments @ncalexan
2018-06-29 17:28:44 +00:00
</div><h4 id='method.known_type_set' class="method"><span id='known_type_set.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.known_type_set' class='fnname'>known_type_set</a>(&amp;self, var: &amp;<a class="struct" href="../edn/query/struct.Variable.html" title="struct edn::query::Variable">Variable</a>) -&gt; <a class="struct" href="../mentat_core/value_type_set/struct.ValueTypeSet.html" title="struct mentat_core::value_type_set::ValueTypeSet">ValueTypeSet</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_algebrizer/clauses/mod.rs.html#441-443' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.is_known_empty' class="method"><span id='is_known_empty.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.is_known_empty' class='fnname'>is_known_empty</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_algebrizer/clauses/mod.rs.html#749-751' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4></div>
Mentat documentation website using Jekyll (#754) 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
2018-06-25 10:20:36 +00:00
<h2 id='implementations' class='small-section-header'>
Trait Implementations<a href='#implementations' class='anchor'></a>
</h2>
<div id='implementations-list'>
<h3 id='impl-PartialEq' 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/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a> for <a class="struct" href="../mentat_query_algebrizer/struct.ConjoiningClauses.html" title="struct mentat_query_algebrizer::ConjoiningClauses">ConjoiningClauses</a></code><a href='#impl-PartialEq' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_algebrizer/clauses/mod.rs.html#228-241' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.eq' class="method"><span id='eq.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq' class='fnname'>eq</a>(&amp;self, other: &amp;<a class="struct" href="../mentat_query_algebrizer/struct.ConjoiningClauses.html" title="struct mentat_query_algebrizer::ConjoiningClauses">ConjoiningClauses</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_algebrizer/clauses/mod.rs.html#229-240' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
</div><h4 id='method.ne' class="method"><span id='ne.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne' class='fnname'>ne</a>(&amp;self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Rhs) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#121' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>This method tests for <code>!=</code>.</p>
</div></div><h3 id='impl-Eq' 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/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> for <a class="struct" href="../mentat_query_algebrizer/struct.ConjoiningClauses.html" title="struct mentat_query_algebrizer::ConjoiningClauses">ConjoiningClauses</a></code><a href='#impl-Eq' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_algebrizer/clauses/mod.rs.html#243' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Debug' 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/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../mentat_query_algebrizer/struct.ConjoiningClauses.html" title="struct mentat_query_algebrizer::ConjoiningClauses">ConjoiningClauses</a></code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_algebrizer/clauses/mod.rs.html#245-260' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, fmt: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_algebrizer/clauses/mod.rs.html#246-259' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
</div></div><h3 id='impl-Default' 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/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="../mentat_query_algebrizer/struct.ConjoiningClauses.html" title="struct mentat_query_algebrizer::ConjoiningClauses">ConjoiningClauses</a></code><a href='#impl-Default' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_algebrizer/clauses/mod.rs.html#263-279' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='docblock'><p>Basics.</p>
</div><div class='impl-items'><h4 id='method.default' class="method"><span id='default.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default' class='fnname'>default</a>() -&gt; <a class="struct" href="../mentat_query_algebrizer/struct.ConjoiningClauses.html" title="struct mentat_query_algebrizer::ConjoiningClauses">ConjoiningClauses</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_algebrizer/clauses/mod.rs.html#264-278' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the &quot;default value&quot; for a type. <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default">Read more</a></p>
</div></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="struct" href="../mentat_query_algebrizer/struct.ConjoiningClauses.html" title="struct mentat_query_algebrizer::ConjoiningClauses">ConjoiningClauses</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="struct" href="../mentat_query_algebrizer/struct.ConjoiningClauses.html" title="struct mentat_query_algebrizer::ConjoiningClauses">ConjoiningClauses</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>&#9166;</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_algebrizer";
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>
Reference in a new issue Copy permalink