mentat/mentat_query_projector/enum.QueryResults.html
2018-08-22 17:04:13 +00:00

166 lines
No EOL
21 KiB
HTML
Raw Permalink 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 `QueryResults` enum in crate `mentat_query_projector`.">
<meta name="keywords" content="rust, rustlang, rust-lang, QueryResults">
<title>mentat_query_projector::QueryResults - 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 QueryResults</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#variants">Variants</a><div class="sidebar-links"><a href="#variant.Scalar">Scalar</a><a href="#variant.Tuple">Tuple</a><a href="#variant.Coll">Coll</a><a href="#variant.Rel">Rel</a></div><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.len">len</a><a href="#method.is_empty">is_empty</a><a href="#method.into_scalar">into_scalar</a><a href="#method.into_coll">into_coll</a><a href="#method.into_tuple">into_tuple</a><a href="#method.into_rel">into_rel</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-PartialEq">PartialEq</a><a href="#impl-Eq">Eq</a><a href="#impl-From%3CQueryOutput%3E">From&lt;QueryOutput&gt;</a></div></div><p class='location'><a href='index.html'>mentat_query_projector</a></p><script>window.sidebarCurrent = {name: 'QueryResults', 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_projector</a>::<wbr><a class="enum" href=''>QueryResults</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_projector/lib.rs.html#129-134' title='goto source code'>[src]</a></span></h1>
<pre class='rust enum'>pub enum QueryResults {
Scalar(<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="../core_traits/enum.Binding.html" title="enum core_traits::Binding">Binding</a>&gt;),
Tuple(<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="enum" href="../core_traits/enum.Binding.html" title="enum core_traits::Binding">Binding</a>&gt;&gt;),
Coll(<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="../core_traits/enum.Binding.html" title="enum core_traits::Binding">Binding</a>&gt;),
Rel(<a class="struct" href="../mentat_query_projector/struct.RelResult.html" title="struct mentat_query_projector::RelResult">RelResult</a>&lt;<a class="enum" href="../core_traits/enum.Binding.html" title="enum core_traits::Binding">Binding</a>&gt;),
}</pre><h2 id='variants' class='variants small-section-header'>
Variants<a href='#variants' class='anchor'></a></h2>
<span id="variant.Scalar" class="variant small-section-header"><a href="#variant.Scalar" class="anchor field"></a><span id='Scalar.v' class='invisible'><code>Scalar(<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="../core_traits/enum.Binding.html" title="enum core_traits::Binding">Binding</a>&gt;)</code></span></span><span id="variant.Tuple" class="variant small-section-header"><a href="#variant.Tuple" class="anchor field"></a><span id='Tuple.v' class='invisible'><code>Tuple(<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="enum" href="../core_traits/enum.Binding.html" title="enum core_traits::Binding">Binding</a>&gt;&gt;)</code></span></span><span id="variant.Coll" class="variant small-section-header"><a href="#variant.Coll" class="anchor field"></a><span id='Coll.v' class='invisible'><code>Coll(<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="../core_traits/enum.Binding.html" title="enum core_traits::Binding">Binding</a>&gt;)</code></span></span><span id="variant.Rel" class="variant small-section-header"><a href="#variant.Rel" class="anchor field"></a><span id='Rel.v' class='invisible'><code>Rel(<a class="struct" href="../mentat_query_projector/struct.RelResult.html" title="struct mentat_query_projector::RelResult">RelResult</a>&lt;<a class="enum" href="../core_traits/enum.Binding.html" title="enum core_traits::Binding">Binding</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="../mentat_query_projector/enum.QueryResults.html" title="enum mentat_query_projector::QueryResults">QueryResults</a></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_projector/lib.rs.html#288-344' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.len' class="method"><span id='len.v' class='invisible'><code>pub fn <a href='#method.len' class='fnname'>len</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_projector/lib.rs.html#289-297' title='goto source code'>[src]</a></span></h4>
<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/mentat_query_projector/lib.rs.html#299-307' title='goto source code'>[src]</a></span></h4>
<h4 id='method.into_scalar' class="method"><span id='into_scalar.v' class='invisible'><code>pub fn <a href='#method.into_scalar' class='fnname'>into_scalar</a>(self) -&gt; <a class="type" href="../query_projector_traits/errors/type.Result.html" title="type query_projector_traits::errors::Result">Result</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="enum" href="../core_traits/enum.Binding.html" title="enum core_traits::Binding">Binding</a>&gt;&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_projector/lib.rs.html#309-316' title='goto source code'>[src]</a></span></h4>
<h4 id='method.into_coll' class="method"><span id='into_coll.v' class='invisible'><code>pub fn <a href='#method.into_coll' class='fnname'>into_coll</a>(self) -&gt; <a class="type" href="../query_projector_traits/errors/type.Result.html" title="type query_projector_traits::errors::Result">Result</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="enum" href="../core_traits/enum.Binding.html" title="enum core_traits::Binding">Binding</a>&gt;&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_projector/lib.rs.html#318-325' title='goto source code'>[src]</a></span></h4>
<h4 id='method.into_tuple' class="method"><span id='into_tuple.v' class='invisible'><code>pub fn <a href='#method.into_tuple' class='fnname'>into_tuple</a>(self) -&gt; <a class="type" href="../query_projector_traits/errors/type.Result.html" title="type query_projector_traits::errors::Result">Result</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="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="enum" href="../core_traits/enum.Binding.html" title="enum core_traits::Binding">Binding</a>&gt;&gt;&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_projector/lib.rs.html#327-334' title='goto source code'>[src]</a></span></h4>
<h4 id='method.into_rel' class="method"><span id='into_rel.v' class='invisible'><code>pub fn <a href='#method.into_rel' class='fnname'>into_rel</a>(self) -&gt; <a class="type" href="../query_projector_traits/errors/type.Result.html" title="type query_projector_traits::errors::Result">Result</a>&lt;<a class="struct" href="../mentat_query_projector/struct.RelResult.html" title="struct mentat_query_projector::RelResult">RelResult</a>&lt;<a class="enum" href="../core_traits/enum.Binding.html" title="enum core_traits::Binding">Binding</a>&gt;&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_projector/lib.rs.html#336-343' title='goto source code'>[src]</a></span></h4>
</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="../mentat_query_projector/enum.QueryResults.html" title="enum mentat_query_projector::QueryResults">QueryResults</a></code><a href='#impl-Clone' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_projector/lib.rs.html#128' 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="../mentat_query_projector/enum.QueryResults.html" title="enum mentat_query_projector::QueryResults">QueryResults</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_projector/lib.rs.html#128' 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="../mentat_query_projector/enum.QueryResults.html" title="enum mentat_query_projector::QueryResults">QueryResults</a></code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_projector/lib.rs.html#128' 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/mentat_query_projector/lib.rs.html#128' 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-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="../mentat_query_projector/enum.QueryResults.html" title="enum mentat_query_projector::QueryResults">QueryResults</a></code><a href='#impl-PartialEq' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_projector/lib.rs.html#128' 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="../mentat_query_projector/enum.QueryResults.html" title="enum mentat_query_projector::QueryResults">QueryResults</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/mentat_query_projector/lib.rs.html#128' 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="../mentat_query_projector/enum.QueryResults.html" title="enum mentat_query_projector::QueryResults">QueryResults</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/mentat_query_projector/lib.rs.html#128' title='goto source code'>[src]</a></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'><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_projector/enum.QueryResults.html" title="enum mentat_query_projector::QueryResults">QueryResults</a></code><a href='#impl-Eq' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_projector/lib.rs.html#128' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'></div><h3 id='impl-From%3CQueryOutput%3E' class='impl'><span class='in-band'><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="struct" href="../mentat_query_projector/struct.QueryOutput.html" title="struct mentat_query_projector::QueryOutput">QueryOutput</a>&gt; for <a class="enum" href="../mentat_query_projector/enum.QueryResults.html" title="enum mentat_query_projector::QueryResults">QueryResults</a></code><a href='#impl-From%3CQueryOutput%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_projector/lib.rs.html#136-140' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.from' class="method"><span id='from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(o: <a class="struct" href="../mentat_query_projector/struct.QueryOutput.html" title="struct mentat_query_projector::QueryOutput">QueryOutput</a>) -&gt; <a class="enum" href="../mentat_query_projector/enum.QueryResults.html" title="enum mentat_query_projector::QueryResults">QueryResults</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_projector/lib.rs.html#137-139' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Performs the conversion.</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 = "mentat_query_projector";
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>