149 lines
No EOL
12 KiB
HTML
149 lines
No EOL
12 KiB
HTML
<!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 `QueryInputs` struct in crate `mentat_query_algebrizer`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, QueryInputs">
|
||
|
||
<title>mentat_query_algebrizer::QueryInputs - 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">☰</div>
|
||
|
||
<p class='location'>Struct QueryInputs</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.with_value_sequence">with_value_sequence</a><a href="#method.with_type_sequence">with_type_sequence</a><a href="#method.with_values">with_values</a><a href="#method.new">new</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Default">Default</a></div></div><p class='location'><a href='index.html'>mentat_query_algebrizer</a></p><script>window.sidebarCurrent = {name: 'QueryInputs', 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'>mentat_query_algebrizer</a>::<wbr><a class="struct" href=''>QueryInputs</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'>−</span>]
|
||
</a>
|
||
</span><a class='srclink' href='../src/mentat_query_algebrizer/clauses/inputs.rs.html#33-36' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust struct'>pub struct QueryInputs { /* fields omitted */ }</pre><div class='docblock'><p>Define the inputs to a query. This is in two parts: a set of values known now, and a set of
|
||
types known now.
|
||
The separate map of types is to allow queries to be algebrized without full knowledge of
|
||
the bindings that will be used at execution time.
|
||
When built correctly, <code>types</code> is guaranteed to contain the types of <code>values</code> -- use
|
||
<code>QueryInputs::new</code> or <code>QueryInputs::with_values</code> to construct an instance.</p>
|
||
</div>
|
||
<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="struct" href="../mentat_query_algebrizer/struct.QueryInputs.html" title="struct mentat_query_algebrizer::QueryInputs">QueryInputs</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_algebrizer/clauses/inputs.rs.html#47-81' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.with_value_sequence' class="method"><span id='with_value_sequence.v' class='invisible'><code>pub fn <a href='#method.with_value_sequence' class='fnname'>with_value_sequence</a>(vals: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="struct" href="../edn/query/struct.Variable.html" title="struct edn::query::Variable">Variable</a>, <a class="enum" href="../core_traits/enum.TypedValue.html" title="enum core_traits::TypedValue">TypedValue</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>>) -> <a class="struct" href="../mentat_query_algebrizer/struct.QueryInputs.html" title="struct mentat_query_algebrizer::QueryInputs">QueryInputs</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_algebrizer/clauses/inputs.rs.html#48-51' title='goto source code'>[src]</a></span></h4>
|
||
<h4 id='method.with_type_sequence' class="method"><span id='with_type_sequence.v' class='invisible'><code>pub fn <a href='#method.with_type_sequence' class='fnname'>with_type_sequence</a>(types: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="struct" href="../edn/query/struct.Variable.html" title="struct edn::query::Variable">Variable</a>, <a class="enum" href="../core_traits/enum.ValueType.html" title="enum core_traits::ValueType">ValueType</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>>) -> <a class="struct" href="../mentat_query_algebrizer/struct.QueryInputs.html" title="struct mentat_query_algebrizer::QueryInputs">QueryInputs</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_algebrizer/clauses/inputs.rs.html#53-58' title='goto source code'>[src]</a></span></h4>
|
||
<h4 id='method.with_values' class="method"><span id='with_values.v' class='invisible'><code>pub fn <a href='#method.with_values' class='fnname'>with_values</a>(values: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/btree/map/struct.BTreeMap.html" title="struct alloc::btree::map::BTreeMap">BTreeMap</a><<a class="struct" href="../edn/query/struct.Variable.html" title="struct edn::query::Variable">Variable</a>, <a class="enum" href="../core_traits/enum.TypedValue.html" title="enum core_traits::TypedValue">TypedValue</a>>) -> <a class="struct" href="../mentat_query_algebrizer/struct.QueryInputs.html" title="struct mentat_query_algebrizer::QueryInputs">QueryInputs</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_algebrizer/clauses/inputs.rs.html#60-65' title='goto source code'>[src]</a></span></h4>
|
||
<h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>pub fn <a href='#method.new' class='fnname'>new</a>(<br> types: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/btree/map/struct.BTreeMap.html" title="struct alloc::btree::map::BTreeMap">BTreeMap</a><<a class="struct" href="../edn/query/struct.Variable.html" title="struct edn::query::Variable">Variable</a>, <a class="enum" href="../core_traits/enum.ValueType.html" title="enum core_traits::ValueType">ValueType</a>>, <br> values: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/btree/map/struct.BTreeMap.html" title="struct alloc::btree::map::BTreeMap">BTreeMap</a><<a class="struct" href="../edn/query/struct.Variable.html" title="struct edn::query::Variable">Variable</a>, <a class="enum" href="../core_traits/enum.TypedValue.html" title="enum core_traits::TypedValue">TypedValue</a>><br>) -> <a class="type" href="../query_algebrizer_traits/errors/type.Result.html" title="type query_algebrizer_traits::errors::Result">Result</a><<a class="struct" href="../mentat_query_algebrizer/struct.QueryInputs.html" title="struct mentat_query_algebrizer::QueryInputs">QueryInputs</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_algebrizer/clauses/inputs.rs.html#67-80' 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-Default' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="../mentat_query_algebrizer/struct.QueryInputs.html" title="struct mentat_query_algebrizer::QueryInputs">QueryInputs</a></code><a href='#impl-Default' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_algebrizer/clauses/inputs.rs.html#38-45' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.default' class="method"><span id='default.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default' class='fnname'>default</a>() -> Self</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/mentat_query_algebrizer/clauses/inputs.rs.html#39-44' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Returns the "default value" for a type. <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default">Read more</a></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>⏎</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> |