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

182 lines
No EOL
16 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 `ParsedQuery` struct in crate `edn`.">
<meta name="keywords" content="rust, rustlang, rust-lang, ParsedQuery">
<title>edn::query::ParsedQuery - 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 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 ParsedQuery</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#fields">Fields</a><div class="sidebar-links"><a href="#structfield.find_spec">find_spec</a><a href="#structfield.default_source">default_source</a><a href="#structfield.with">with</a><a href="#structfield.in_vars">in_vars</a><a href="#structfield.in_sources">in_sources</a><a href="#structfield.limit">limit</a><a href="#structfield.where_clauses">where_clauses</a><a href="#structfield.order">order</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Eq">Eq</a><a href="#impl-PartialEq">PartialEq</a></div></div><p class='location'><a href='../index.html'>edn</a>::<wbr><a href='index.html'>query</a></p><script>window.sidebarCurrent = {name: 'ParsedQuery', 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'>edn</a>::<wbr><a href='index.html'>query</a>::<wbr><a class="struct" href=''>ParsedQuery</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#981-990' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct ParsedQuery {
pub find_spec: <a class="enum" href="../../edn/query/enum.FindSpec.html" title="enum edn::query::FindSpec">FindSpec</a>,
pub default_source: <a class="enum" href="../../edn/query/enum.SrcVar.html" title="enum edn::query::SrcVar">SrcVar</a>,
pub with: <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="../../edn/query/struct.Variable.html" title="struct edn::query::Variable">Variable</a>&gt;,
pub in_vars: <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="../../edn/query/struct.Variable.html" title="struct edn::query::Variable">Variable</a>&gt;,
pub in_sources: <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="enum" href="../../edn/query/enum.SrcVar.html" title="enum edn::query::SrcVar">SrcVar</a>&gt;,
pub limit: <a class="enum" href="../../edn/query/enum.Limit.html" title="enum edn::query::Limit">Limit</a>,
pub where_clauses: <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.WhereClause.html" title="enum edn::query::WhereClause">WhereClause</a>&gt;,
pub order: <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="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="../../edn/query/struct.Order.html" title="struct edn::query::Order">Order</a>&gt;&gt;,
}</pre><h2 id='fields' class='fields small-section-header'>
Fields<a href='#fields' class='anchor'></a></h2><span id="structfield.find_spec" class="structfield small-section-header">
<a href="#structfield.find_spec" class="anchor field"></a>
<span id="find_spec.v" class='invisible'>
<code>find_spec: <a class="enum" href="../../edn/query/enum.FindSpec.html" title="enum edn::query::FindSpec">FindSpec</a></code>
</span></span><span id="structfield.default_source" class="structfield small-section-header">
<a href="#structfield.default_source" class="anchor field"></a>
<span id="default_source.v" class='invisible'>
<code>default_source: <a class="enum" href="../../edn/query/enum.SrcVar.html" title="enum edn::query::SrcVar">SrcVar</a></code>
</span></span><span id="structfield.with" class="structfield small-section-header">
<a href="#structfield.with" class="anchor field"></a>
<span id="with.v" class='invisible'>
<code>with: <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="../../edn/query/struct.Variable.html" title="struct edn::query::Variable">Variable</a>&gt;</code>
</span></span><span id="structfield.in_vars" class="structfield small-section-header">
<a href="#structfield.in_vars" class="anchor field"></a>
<span id="in_vars.v" class='invisible'>
<code>in_vars: <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="../../edn/query/struct.Variable.html" title="struct edn::query::Variable">Variable</a>&gt;</code>
</span></span><span id="structfield.in_sources" class="structfield small-section-header">
<a href="#structfield.in_sources" class="anchor field"></a>
<span id="in_sources.v" class='invisible'>
<code>in_sources: <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="enum" href="../../edn/query/enum.SrcVar.html" title="enum edn::query::SrcVar">SrcVar</a>&gt;</code>
</span></span><span id="structfield.limit" class="structfield small-section-header">
<a href="#structfield.limit" class="anchor field"></a>
<span id="limit.v" class='invisible'>
<code>limit: <a class="enum" href="../../edn/query/enum.Limit.html" title="enum edn::query::Limit">Limit</a></code>
</span></span><span id="structfield.where_clauses" class="structfield small-section-header">
<a href="#structfield.where_clauses" class="anchor field"></a>
<span id="where_clauses.v" class='invisible'>
<code>where_clauses: <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.WhereClause.html" title="enum edn::query::WhereClause">WhereClause</a>&gt;</code>
</span></span><span id="structfield.order" class="structfield small-section-header">
<a href="#structfield.order" class="anchor field"></a>
<span id="order.v" class='invisible'>
<code>order: <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="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="../../edn/query/struct.Order.html" title="struct edn::query::Order">Order</a>&gt;&gt;</code>
</span></span>
<h2 id='implementations' class='small-section-header'>
Trait Implementations<a href='#implementations' class='anchor'></a>
</h2>
<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="struct" href="../../edn/query/struct.ParsedQuery.html" title="struct edn::query::ParsedQuery">ParsedQuery</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#980' 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#980' 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="struct" href="../../edn/query/struct.ParsedQuery.html" title="struct edn::query::ParsedQuery">ParsedQuery</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#980' 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="struct" href="../../edn/query/struct.ParsedQuery.html" title="struct edn::query::ParsedQuery">ParsedQuery</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#980' 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="struct" href="../../edn/query/struct.ParsedQuery.html" title="struct edn::query::ParsedQuery">ParsedQuery</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#980' 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="struct" href="../../edn/query/struct.ParsedQuery.html" title="struct edn::query::ParsedQuery">ParsedQuery</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#980' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>This method tests for <code>!=</code>.</p>
</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 = "edn";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>