mentat/edn/query/enum.Binding.html
2018-08-22 17:04:13 +00:00

182 lines
No EOL
22 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 `Binding` enum in crate `edn`.">
<meta name="keywords" content="rust, rustlang, rust-lang, Binding">
<title>edn::query::Binding - 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="../../main.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 Binding</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#variants">Variants</a><div class="sidebar-links"><a href="#variant.BindScalar">BindScalar</a><a href="#variant.BindColl">BindColl</a><a href="#variant.BindRel">BindRel</a><a href="#variant.BindTuple">BindTuple</a></div><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.variables">variables</a><a href="#method.is_empty">is_empty</a><a href="#method.is_valid">is_valid</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Debug">Debug</a><a href="#impl-Eq">Eq</a><a href="#impl-PartialEq">PartialEq</a><a href="#impl-ContainsVariables">ContainsVariables</a></div></div><p class='location'><a href='../index.html'>edn</a>::<wbr><a href='index.html'>query</a></p><script>window.sidebarCurrent = {name: 'Binding', 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'>edn</a>::<wbr><a href='index.html'>query</a>::<wbr><a class="enum" href=''>Binding</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/edn/query.rs.html#752-757' title='goto source code'>[src]</a></span></h1>
<pre class='rust enum'>pub enum Binding {
BindScalar(<a class="struct" href="../../edn/query/struct.Variable.html" title="struct edn::query::Variable">Variable</a>),
BindColl(<a class="struct" href="../../edn/query/struct.Variable.html" title="struct edn::query::Variable">Variable</a>),
BindRel(<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="../../edn/query/enum.VariableOrPlaceholder.html" title="enum edn::query::VariableOrPlaceholder">VariableOrPlaceholder</a>&gt;),
BindTuple(<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="../../edn/query/enum.VariableOrPlaceholder.html" title="enum edn::query::VariableOrPlaceholder">VariableOrPlaceholder</a>&gt;),
}</pre><h2 id='variants' class='variants small-section-header'>
Variants<a href='#variants' class='anchor'></a></h2>
<span id="variant.BindScalar" class="variant small-section-header"><a href="#variant.BindScalar" class="anchor field"></a><span id='BindScalar.v' class='invisible'><code>BindScalar(<a class="struct" href="../../edn/query/struct.Variable.html" title="struct edn::query::Variable">Variable</a>)</code></span></span><span id="variant.BindColl" class="variant small-section-header"><a href="#variant.BindColl" class="anchor field"></a><span id='BindColl.v' class='invisible'><code>BindColl(<a class="struct" href="../../edn/query/struct.Variable.html" title="struct edn::query::Variable">Variable</a>)</code></span></span><span id="variant.BindRel" class="variant small-section-header"><a href="#variant.BindRel" class="anchor field"></a><span id='BindRel.v' class='invisible'><code>BindRel(<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="../../edn/query/enum.VariableOrPlaceholder.html" title="enum edn::query::VariableOrPlaceholder">VariableOrPlaceholder</a>&gt;)</code></span></span><span id="variant.BindTuple" class="variant small-section-header"><a href="#variant.BindTuple" class="anchor field"></a><span id='BindTuple.v' class='invisible'><code>BindTuple(<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="../../edn/query/enum.VariableOrPlaceholder.html" title="enum edn::query::VariableOrPlaceholder">VariableOrPlaceholder</a>&gt;)</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'><code>impl <a class="enum" href="../../edn/query/enum.Binding.html" title="enum edn::query::Binding">Binding</a></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/edn/query.rs.html#759-813' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.variables' class="method"><div class="important-traits"><div class='tooltip'><span class='tooltiptext'>Important traits for <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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>&gt;</span></div><div class="content hidden"><h3 class="important">Important traits for <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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>&gt;</h3><code class="content"><span class="where fmt-newline">impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>&gt;</span></code></div></div><span id='variables.v' class='invisible'><code>pub fn <a href='#method.variables' class='fnname'>variables</a>(&amp;self) -&gt; <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="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../../edn/query/struct.Variable.html" title="struct edn::query::Variable">Variable</a>&gt;&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/edn/query.rs.html#761-766' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Return each variable or <code>None</code>, in order.</p>
</div><h4 id='method.is_empty' class="method"><span id='is_empty.v' class='invisible'><code>pub fn <a href='#method.is_empty' class='fnname'>is_empty</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/edn/query.rs.html#769-774' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Return <code>true</code> if no variables are bound, i.e., all binding entries are placeholders.</p>
</div><h4 id='method.is_valid' class="method"><span id='is_valid.v' class='invisible'><code>pub fn <a href='#method.is_valid' class='fnname'>is_valid</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/edn/query.rs.html#794-812' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Return <code>true</code> if no variable is bound twice, i.e., each binding entry is either a
placeholder or unique.</p>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">edn</span>::<span class="ident">query</span>::{<span class="ident">Binding</span>,<span class="ident">Variable</span>,<span class="ident">VariableOrPlaceholder</span>};
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">rc</span>::<span class="ident">Rc</span>;
<span class="kw">let</span> <span class="ident">v</span> <span class="op">=</span> <span class="ident">Variable</span>::<span class="ident">from_valid_name</span>(<span class="string">&quot;?foo&quot;</span>);
<span class="kw">let</span> <span class="ident">vv</span> <span class="op">=</span> <span class="ident">VariableOrPlaceholder</span>::<span class="ident">Variable</span>(<span class="ident">v</span>);
<span class="kw">let</span> <span class="ident">p</span> <span class="op">=</span> <span class="ident">VariableOrPlaceholder</span>::<span class="ident">Placeholder</span>;
<span class="kw">let</span> <span class="ident">e</span> <span class="op">=</span> <span class="ident">Binding</span>::<span class="ident">BindTuple</span>(<span class="macro">vec</span><span class="macro">!</span>[<span class="ident">p</span>.<span class="ident">clone</span>()]);
<span class="kw">let</span> <span class="ident">b</span> <span class="op">=</span> <span class="ident">Binding</span>::<span class="ident">BindTuple</span>(<span class="macro">vec</span><span class="macro">!</span>[<span class="ident">p</span>.<span class="ident">clone</span>(), <span class="ident">vv</span>.<span class="ident">clone</span>()]);
<span class="kw">let</span> <span class="ident">d</span> <span class="op">=</span> <span class="ident">Binding</span>::<span class="ident">BindTuple</span>(<span class="macro">vec</span><span class="macro">!</span>[<span class="ident">vv</span>.<span class="ident">clone</span>(), <span class="ident">p</span>, <span class="ident">vv</span>]);
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">b</span>.<span class="ident">is_valid</span>()); <span class="comment">// One var, one placeholder: OK.</span>
<span class="macro">assert</span><span class="macro">!</span>(<span class="op">!</span><span class="ident">e</span>.<span class="ident">is_valid</span>()); <span class="comment">// Empty: not OK.</span>
<span class="macro">assert</span><span class="macro">!</span>(<span class="op">!</span><span class="ident">d</span>.<span class="ident">is_valid</span>()); <span class="comment">// Duplicate var: not OK.</span></pre>
</div></div>
<h2 id='implementations' class='small-section-header'>
Trait Implementations<a href='#implementations' class='anchor'></a>
</h2>
<h3 id='impl-Clone' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="enum" href="../../edn/query/enum.Binding.html" title="enum edn::query::Binding">Binding</a></code><a href='#impl-Clone' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/edn/query.rs.html#751' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&amp;self) -&gt; <a class="enum" href="../../edn/query/enum.Binding.html" title="enum edn::query::Binding">Binding</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/edn/query.rs.html#751' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&amp;mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self)</code></span><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/clone.rs.html#112-114' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
</div></div><h3 id='impl-Debug' class='impl'><span class='in-band'><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="../../edn/query/enum.Binding.html" title="enum edn::query::Binding">Binding</a></code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/edn/query.rs.html#751' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, __arg_0: &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><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/edn/query.rs.html#751' title='goto source code'>[src]</a></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-Eq' class='impl'><span class='in-band'><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="../../edn/query/enum.Binding.html" title="enum edn::query::Binding">Binding</a></code><a href='#impl-Eq' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/edn/query.rs.html#751' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'></div><h3 id='impl-PartialEq' class='impl'><span class='in-band'><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="../../edn/query/enum.Binding.html" title="enum edn::query::Binding">Binding</a></code><a href='#impl-PartialEq' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/edn/query.rs.html#751' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.eq' class="method"><span id='eq.v' class='invisible'><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="../../edn/query/enum.Binding.html" title="enum edn::query::Binding">Binding</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/edn/query.rs.html#751' title='goto source code'>[src]</a></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'><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="../../edn/query/enum.Binding.html" title="enum edn::query::Binding">Binding</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/edn/query.rs.html#751' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>This method tests for <code>!=</code>.</p>
</div></div><h3 id='impl-ContainsVariables' class='impl'><span class='in-band'><code>impl <a class="trait" href="../../edn/query/trait.ContainsVariables.html" title="trait edn::query::ContainsVariables">ContainsVariables</a> for <a class="enum" href="../../edn/query/enum.Binding.html" title="enum edn::query::Binding">Binding</a></code><a href='#impl-ContainsVariables' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/edn/query.rs.html#1189-1204' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.accumulate_mentioned_variables' class="method"><span id='accumulate_mentioned_variables.v' class='invisible'><code>fn <a href='../../edn/query/trait.ContainsVariables.html#tymethod.accumulate_mentioned_variables' class='fnname'>accumulate_mentioned_variables</a>(&amp;self, acc: &amp;mut <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><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/edn/query.rs.html#1190-1203' title='goto source code'>[src]</a></span></h4>
<h4 id='method.collect_mentioned_variables' class="method"><span id='collect_mentioned_variables.v' class='invisible'><code>fn <a href='../../edn/query/trait.ContainsVariables.html#method.collect_mentioned_variables' class='fnname'>collect_mentioned_variables</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><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/edn/query.rs.html#1102-1106' title='goto source code'>[src]</a></span></h4>
</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 = "edn";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>