mentat/mentat_transaction/trait.Queryable.html
2018-08-22 17:04:13 +00:00

147 lines
No EOL
17 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 `Queryable` trait in crate `mentat_transaction`.">
<meta name="keywords" content="rust, rustlang, rust-lang, Queryable">
<title>mentat_transaction::Queryable - 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 trait">
<!--[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'>Trait Queryable</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.q_explain">q_explain</a><a href="#tymethod.q_once">q_once</a><a href="#tymethod.q_prepare">q_prepare</a><a href="#tymethod.lookup_values_for_attribute">lookup_values_for_attribute</a><a href="#tymethod.lookup_value_for_attribute">lookup_value_for_attribute</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>mentat_transaction</a></p><script>window.sidebarCurrent = {name: 'Queryable', ty: 'trait', 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'>Trait <a href='index.html'>mentat_transaction</a>::<wbr><a class="trait" href=''>Queryable</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_transaction/lib.rs.html#160-171' title='goto source code'>[src]</a></span></h1>
<pre class='rust trait'>pub trait Queryable {
fn <a href='#tymethod.q_explain' class='fnname'>q_explain</a>&lt;T&gt;(&amp;self, query: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, inputs: T) -&gt; <a class="type" href="../public_traits/errors/type.Result.html" title="type public_traits::errors::Result">Result</a>&lt;<a class="enum" href="../mentat_transaction/query/enum.QueryExplanation.html" title="enum mentat_transaction::query::QueryExplanation">QueryExplanation</a>&gt;<br>&nbsp;&nbsp;&nbsp; <span class="where">where<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</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="../mentat_transaction/query/struct.QueryInputs.html" title="struct mentat_transaction::query::QueryInputs">QueryInputs</a>&gt;&gt;</span>;
<div class='item-spacer'></div> fn <a href='#tymethod.q_once' class='fnname'>q_once</a>&lt;T&gt;(&amp;self, query: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, inputs: T) -&gt; <a class="type" href="../public_traits/errors/type.Result.html" title="type public_traits::errors::Result">Result</a>&lt;<a class="struct" href="../mentat_transaction/query/struct.QueryOutput.html" title="struct mentat_transaction::query::QueryOutput">QueryOutput</a>&gt;<br>&nbsp;&nbsp;&nbsp; <span class="where">where<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</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="../mentat_transaction/query/struct.QueryInputs.html" title="struct mentat_transaction::query::QueryInputs">QueryInputs</a>&gt;&gt;</span>;
<div class='item-spacer'></div> fn <a href='#tymethod.q_prepare' class='fnname'>q_prepare</a>&lt;T&gt;(&amp;self, query: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, inputs: T) -&gt; <a class="type" href="../mentat_transaction/query/type.PreparedResult.html" title="type mentat_transaction::query::PreparedResult">PreparedResult</a><br>&nbsp;&nbsp;&nbsp; <span class="where">where<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</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="../mentat_transaction/query/struct.QueryInputs.html" title="struct mentat_transaction::query::QueryInputs">QueryInputs</a>&gt;&gt;</span>;
<div class='item-spacer'></div> fn <a href='#tymethod.lookup_values_for_attribute' class='fnname'>lookup_values_for_attribute</a>&lt;E&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;entity: E, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;attribute: &amp;<a class="struct" href="../mentat_transaction/query/struct.Keyword.html" title="struct mentat_transaction::query::Keyword">Keyword</a><br>&nbsp;&nbsp;&nbsp;&nbsp;) -&gt; <a class="type" href="../public_traits/errors/type.Result.html" title="type public_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.TypedValue.html" title="enum core_traits::TypedValue">TypedValue</a>&gt;&gt;<br>&nbsp;&nbsp;&nbsp; <span class="where">where<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;E: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="type" href="../core_traits/type.Entid.html" title="type core_traits::Entid">Entid</a>&gt;</span>;
<div class='item-spacer'></div> fn <a href='#tymethod.lookup_value_for_attribute' class='fnname'>lookup_value_for_attribute</a>&lt;E&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;entity: E, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;attribute: &amp;<a class="struct" href="../mentat_transaction/query/struct.Keyword.html" title="struct mentat_transaction::query::Keyword">Keyword</a><br>&nbsp;&nbsp;&nbsp;&nbsp;) -&gt; <a class="type" href="../public_traits/errors/type.Result.html" title="type public_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.TypedValue.html" title="enum core_traits::TypedValue">TypedValue</a>&gt;&gt;<br>&nbsp;&nbsp;&nbsp; <span class="where">where<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;E: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="type" href="../core_traits/type.Entid.html" title="type core_traits::Entid">Entid</a>&gt;</span>;
}</pre>
<h2 id='required-methods' class='small-section-header'>
Required Methods<a href='#required-methods' class='anchor'></a>
</h2>
<div class='methods'>
<h3 id='tymethod.q_explain' class='method'><span id='q_explain.v' class='invisible'><code>fn <a href='#tymethod.q_explain' class='fnname'>q_explain</a>&lt;T&gt;(&amp;self, query: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, inputs: T) -&gt; <a class="type" href="../public_traits/errors/type.Result.html" title="type public_traits::errors::Result">Result</a>&lt;<a class="enum" href="../mentat_transaction/query/enum.QueryExplanation.html" title="enum mentat_transaction::query::QueryExplanation">QueryExplanation</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</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="../mentat_transaction/query/struct.QueryInputs.html" title="struct mentat_transaction::query::QueryInputs">QueryInputs</a>&gt;&gt;,&nbsp;</span></code></span></h3><h3 id='tymethod.q_once' class='method'><span id='q_once.v' class='invisible'><code>fn <a href='#tymethod.q_once' class='fnname'>q_once</a>&lt;T&gt;(&amp;self, query: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, inputs: T) -&gt; <a class="type" href="../public_traits/errors/type.Result.html" title="type public_traits::errors::Result">Result</a>&lt;<a class="struct" href="../mentat_transaction/query/struct.QueryOutput.html" title="struct mentat_transaction::query::QueryOutput">QueryOutput</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</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="../mentat_transaction/query/struct.QueryInputs.html" title="struct mentat_transaction::query::QueryInputs">QueryInputs</a>&gt;&gt;,&nbsp;</span></code></span></h3><h3 id='tymethod.q_prepare' class='method'><span id='q_prepare.v' class='invisible'><code>fn <a href='#tymethod.q_prepare' class='fnname'>q_prepare</a>&lt;T&gt;(&amp;self, query: &amp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, inputs: T) -&gt; <a class="type" href="../mentat_transaction/query/type.PreparedResult.html" title="type mentat_transaction::query::PreparedResult">PreparedResult</a> <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</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="../mentat_transaction/query/struct.QueryInputs.html" title="struct mentat_transaction::query::QueryInputs">QueryInputs</a>&gt;&gt;,&nbsp;</span></code></span></h3><h3 id='tymethod.lookup_values_for_attribute' class='method'><span id='lookup_values_for_attribute.v' class='invisible'><code>fn <a href='#tymethod.lookup_values_for_attribute' class='fnname'>lookup_values_for_attribute</a>&lt;E&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;entity: E, <br>&nbsp;&nbsp;&nbsp;&nbsp;attribute: &amp;<a class="struct" href="../mentat_transaction/query/struct.Keyword.html" title="struct mentat_transaction::query::Keyword">Keyword</a><br>) -&gt; <a class="type" href="../public_traits/errors/type.Result.html" title="type public_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.TypedValue.html" title="enum core_traits::TypedValue">TypedValue</a>&gt;&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;E: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="type" href="../core_traits/type.Entid.html" title="type core_traits::Entid">Entid</a>&gt;,&nbsp;</span></code></span></h3><h3 id='tymethod.lookup_value_for_attribute' class='method'><span id='lookup_value_for_attribute.v' class='invisible'><code>fn <a href='#tymethod.lookup_value_for_attribute' class='fnname'>lookup_value_for_attribute</a>&lt;E&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;entity: E, <br>&nbsp;&nbsp;&nbsp;&nbsp;attribute: &amp;<a class="struct" href="../mentat_transaction/query/struct.Keyword.html" title="struct mentat_transaction::query::Keyword">Keyword</a><br>) -&gt; <a class="type" href="../public_traits/errors/type.Result.html" title="type public_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.TypedValue.html" title="enum core_traits::TypedValue">TypedValue</a>&gt;&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;E: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="type" href="../core_traits/type.Entid.html" title="type core_traits::Entid">Entid</a>&gt;,&nbsp;</span></code></span></h3></div>
<h2 id='implementors' class='small-section-header'>
Implementors<a href='#implementors' class='anchor'></a>
</h2>
<ul class='item-list' id='implementors-list'>
<li><div class='out-of-band'><a class='srclink' href='../src/mentat_transaction/lib.rs.html#332-357' title='goto source code'>[src]</a></div><code>impl&lt;'a, 'c&gt; Queryable for <a class="struct" href="../mentat_transaction/struct.InProgressRead.html" title="struct mentat_transaction::InProgressRead">InProgressRead</a>&lt;'a, 'c&gt;</code></li>
<li><div class='out-of-band'><a class='srclink' href='../src/mentat_transaction/lib.rs.html#372-421' title='goto source code'>[src]</a></div><code>impl&lt;'a, 'c&gt; Queryable for <a class="struct" href="../mentat_transaction/struct.InProgress.html" title="struct mentat_transaction::InProgress">InProgress</a>&lt;'a, 'c&gt;</code></li>
</ul><script type="text/javascript" async
src="../implementors/mentat_transaction/trait.Queryable.js">
</script></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_transaction";
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>