mentat/docs/apis/rust/0.7.0/mentat_query_algebrizer/enum.ColumnConstraint.html
Emily Toop c5180656cc
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 11:20:36 +01:00

164 lines
No EOL
20 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 `ColumnConstraint` enum in crate `mentat_query_algebrizer`.">
<meta name="keywords" content="rust, rustlang, rust-lang, ColumnConstraint">
<title>mentat_query_algebrizer::ColumnConstraint - 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">&#9776;</div>
<p class='location'>Enum ColumnConstraint</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#variants">Variants</a><div class="sidebar-links"><a href="#variant.Equals">Equals</a><a href="#variant.Inequality">Inequality</a><a href="#variant.HasTypes">HasTypes</a><a href="#variant.NotExists">NotExists</a><a href="#variant.Matches">Matches</a></div><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.has_unit_type">has_unit_type</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-From%3CColumnConstraint%3E">From&lt;ColumnConstraint&gt;</a><a href="#impl-Debug">Debug</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: 'ColumnConstraint', 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_algebrizer</a>::<wbr><a class="enum" href=''>ColumnConstraint</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/types.rs.html#444-458' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust enum'>pub enum ColumnConstraint {
Equals(<a class="struct" href="../mentat_query_algebrizer/struct.QualifiedAlias.html" title="struct mentat_query_algebrizer::QualifiedAlias">QualifiedAlias</a>,&nbsp;<a class="enum" href="../mentat_query_algebrizer/enum.QueryValue.html" title="enum mentat_query_algebrizer::QueryValue">QueryValue</a>),
Inequality {
operator: Inequality,
left: <a class="enum" href="../mentat_query_algebrizer/enum.QueryValue.html" title="enum mentat_query_algebrizer::QueryValue">QueryValue</a>,
right: <a class="enum" href="../mentat_query_algebrizer/enum.QueryValue.html" title="enum mentat_query_algebrizer::QueryValue">QueryValue</a>,
},
HasTypes {
value: <a class="type" href="../mentat_query_algebrizer/type.TableAlias.html" title="type mentat_query_algebrizer::TableAlias">TableAlias</a>,
value_types: ValueTypeSet,
check_value: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>,
},
NotExists(<a class="enum" href="../mentat_query_algebrizer/enum.ComputedTable.html" title="enum mentat_query_algebrizer::ComputedTable">ComputedTable</a>),
Matches(<a class="struct" href="../mentat_query_algebrizer/struct.QualifiedAlias.html" title="struct mentat_query_algebrizer::QualifiedAlias">QualifiedAlias</a>,&nbsp;<a class="enum" href="../mentat_query_algebrizer/enum.QueryValue.html" title="enum mentat_query_algebrizer::QueryValue">QueryValue</a>),
}</pre></div><h2 id='variants' class='variants small-section-header'>
Variants<a href='#variants' class='anchor'></a></h2>
<span id="variant.Equals" class="variant small-section-header"><a href="#variant.Equals" class="anchor field"></a><span id='Equals.v' class='invisible'><code>Equals(<a class="struct" href="../mentat_query_algebrizer/struct.QualifiedAlias.html" title="struct mentat_query_algebrizer::QualifiedAlias">QualifiedAlias</a>,&nbsp;<a class="enum" href="../mentat_query_algebrizer/enum.QueryValue.html" title="enum mentat_query_algebrizer::QueryValue">QueryValue</a>)</code></span></span><span id="variant.Inequality" class="variant small-section-header"><a href="#variant.Inequality" class="anchor field"></a><span id='Inequality.v' class='invisible'><code>Inequality</code></span></span><span class='docblock autohide sub-variant' id='variant.Inequality.fields'><h3 class='fields'>Fields of <code>Inequality</code></h3>
<table><tr><td id='variant.Inequality.field.operator'><span id='Inequality.v.operator.v' class='invisible'><code>operator:&nbsp;Inequality</code></span></td><td></td></tr><tr><td id='variant.Inequality.field.left'><span id='Inequality.v.left.v' class='invisible'><code>left:&nbsp;<a class="enum" href="../mentat_query_algebrizer/enum.QueryValue.html" title="enum mentat_query_algebrizer::QueryValue">QueryValue</a></code></span></td><td></td></tr><tr><td id='variant.Inequality.field.right'><span id='Inequality.v.right.v' class='invisible'><code>right:&nbsp;<a class="enum" href="../mentat_query_algebrizer/enum.QueryValue.html" title="enum mentat_query_algebrizer::QueryValue">QueryValue</a></code></span></td><td></td></tr></table></span><span id="variant.HasTypes" class="variant small-section-header"><a href="#variant.HasTypes" class="anchor field"></a><span id='HasTypes.v' class='invisible'><code>HasTypes</code></span></span><span class='docblock autohide sub-variant' id='variant.HasTypes.fields'><h3 class='fields'>Fields of <code>HasTypes</code></h3>
<table><tr><td id='variant.HasTypes.field.value'><span id='HasTypes.v.value.v' class='invisible'><code>value:&nbsp;<a class="type" href="../mentat_query_algebrizer/type.TableAlias.html" title="type mentat_query_algebrizer::TableAlias">TableAlias</a></code></span></td><td></td></tr><tr><td id='variant.HasTypes.field.value_types'><span id='HasTypes.v.value_types.v' class='invisible'><code>value_types:&nbsp;ValueTypeSet</code></span></td><td></td></tr><tr><td id='variant.HasTypes.field.check_value'><span id='HasTypes.v.check_value.v' class='invisible'><code>check_value:&nbsp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</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(<a class="enum" href="../mentat_query_algebrizer/enum.ComputedTable.html" title="enum mentat_query_algebrizer::ComputedTable">ComputedTable</a>)</code></span></span><span id="variant.Matches" class="variant small-section-header"><a href="#variant.Matches" class="anchor field"></a><span id='Matches.v' class='invisible'><code>Matches(<a class="struct" href="../mentat_query_algebrizer/struct.QualifiedAlias.html" title="struct mentat_query_algebrizer::QualifiedAlias">QualifiedAlias</a>,&nbsp;<a class="enum" href="../mentat_query_algebrizer/enum.QueryValue.html" title="enum mentat_query_algebrizer::QueryValue">QueryValue</a>)</code></span></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_algebrizer/enum.ColumnConstraint.html" title="enum mentat_query_algebrizer::ColumnConstraint">ColumnConstraint</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/types.rs.html#460-468' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.has_unit_type' class="method"><span id='has_unit_type.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.has_unit_type' class='fnname'>has_unit_type</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;value: <a class="type" href="../mentat_query_algebrizer/type.TableAlias.html" title="type mentat_query_algebrizer::TableAlias">TableAlias</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;value_type: ValueType<br>) -&gt; <a class="enum" href="../mentat_query_algebrizer/enum.ColumnConstraint.html" title="enum mentat_query_algebrizer::ColumnConstraint">ColumnConstraint</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_algebrizer/types.rs.html#461-467' 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-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="enum" href="../mentat_query_algebrizer/enum.ColumnConstraint.html" title="enum mentat_query_algebrizer::ColumnConstraint">ColumnConstraint</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/types.rs.html#443' 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, __arg_0: &amp;<a class="enum" href="../mentat_query_algebrizer/enum.ColumnConstraint.html" title="enum mentat_query_algebrizer::ColumnConstraint">ColumnConstraint</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/types.rs.html#443' 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, __arg_0: &amp;<a class="enum" href="../mentat_query_algebrizer/enum.ColumnConstraint.html" title="enum mentat_query_algebrizer::ColumnConstraint">ColumnConstraint</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/types.rs.html#443' 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="enum" href="../mentat_query_algebrizer/enum.ColumnConstraint.html" title="enum mentat_query_algebrizer::ColumnConstraint">ColumnConstraint</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/types.rs.html#443' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-From%3CColumnConstraint%3E' 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/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;<a class="enum" href="../mentat_query_algebrizer/enum.ColumnConstraint.html" title="enum mentat_query_algebrizer::ColumnConstraint">ColumnConstraint</a>&gt; for <a class="enum" href="../mentat_query_algebrizer/enum.ColumnConstraintOrAlternation.html" title="enum mentat_query_algebrizer::ColumnConstraintOrAlternation">ColumnConstraintOrAlternation</a></code><a href='#impl-From%3CColumnConstraint%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_algebrizer/types.rs.html#476-480' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.from' class="method"><span id='from.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(thing: <a class="enum" href="../mentat_query_algebrizer/enum.ColumnConstraint.html" title="enum mentat_query_algebrizer::ColumnConstraint">ColumnConstraint</a>) -&gt; Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_algebrizer/types.rs.html#477-479' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs the conversion.</p>
</div></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="enum" href="../mentat_query_algebrizer/enum.ColumnConstraint.html" title="enum mentat_query_algebrizer::ColumnConstraint">ColumnConstraint</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/types.rs.html#566-602' 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, f: &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/types.rs.html#567-601' 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></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_algebrizer/enum.ColumnConstraint.html" title="enum mentat_query_algebrizer::ColumnConstraint">ColumnConstraint</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_algebrizer/enum.ColumnConstraint.html" title="enum mentat_query_algebrizer::ColumnConstraint">ColumnConstraint</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>