mentat/docs/apis/0.7/rust/edn/query/index.html

375 lines
18 KiB
HTML
Raw Permalink Normal View History

<!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 `query` mod in crate `edn`.">
<meta name="keywords" content="rust, rustlang, rust-lang, query">
<title>edn::query - 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="../../light.css" id="themeStyle">
<script src="../../storage.js"></script>
</head>
<body class="rustdoc mod">
<!--[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'>Module query</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#reexports">Re-exports</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'><a href='../index.html'>edn</a></p><script>window.sidebarCurrent = {name: 'query', ty: 'mod', 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'>Module <a href='../index.html'>edn</a>::<wbr><a class="mod" href=''>query</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#11-1239' title='goto source code'>[src]</a></span></h1><h2 id='reexports' class='section-header'><a href="#reexports">Re-exports</a></h2>
<table><tr><td><code>pub use <a class="struct" href="../../edn/symbols/struct.Keyword.html" title="struct edn::symbols::Keyword">Keyword</a>;</code></td></tr><tr><td><code>pub use <a class="struct" href="../../edn/symbols/struct.PlainSymbol.html" title="struct edn::symbols::PlainSymbol">PlainSymbol</a>;</code></td></tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
<tr class=' module-item'>
<td><a class="struct" href="struct.Aggregate.html"
title='struct edn::query::Aggregate'>Aggregate</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.NamedPullAttribute.html"
title='struct edn::query::NamedPullAttribute'>NamedPullAttribute</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.NotJoin.html"
title='struct edn::query::NotJoin'>NotJoin</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.OrJoin.html"
title='struct edn::query::OrJoin'>OrJoin</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Order.html"
title='struct edn::query::Order'>Order</a></td>
<td class='docblock-short'>
<p>An abstract declaration of ordering: direction and variable.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.ParsedQuery.html"
title='struct edn::query::ParsedQuery'>ParsedQuery</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Pattern.html"
title='struct edn::query::Pattern'>Pattern</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Predicate.html"
title='struct edn::query::Predicate'>Predicate</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Pull.html"
title='struct edn::query::Pull'>Pull</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.QueryFunction.html"
title='struct edn::query::QueryFunction'>QueryFunction</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.TypeAnnotation.html"
title='struct edn::query::TypeAnnotation'>TypeAnnotation</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Variable.html"
title='struct edn::query::Variable'>Variable</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.WhereFn.html"
title='struct edn::query::WhereFn'>WhereFn</a></td>
<td class='docblock-short'>
</td>
</tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
<table>
<tr class=' module-item'>
<td><a class="enum" href="enum.Binding.html"
title='enum edn::query::Binding'>Binding</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.Direction.html"
title='enum edn::query::Direction'>Direction</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.Element.html"
title='enum edn::query::Element'>Element</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.FindSpec.html"
title='enum edn::query::FindSpec'>FindSpec</a></td>
<td class='docblock-short'>
<p>A definition of the first part of a find query: the
<code>[:find ?foo ?bar…]</code> bit.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.FnArg.html"
title='enum edn::query::FnArg'>FnArg</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.IdentOrEntid.html"
title='enum edn::query::IdentOrEntid'>IdentOrEntid</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.Limit.html"
title='enum edn::query::Limit'>Limit</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.NonIntegerConstant.html"
title='enum edn::query::NonIntegerConstant'>NonIntegerConstant</a></td>
<td class='docblock-short'>
<p>These are the scalar values representable in EDN.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.OrWhereClause.html"
title='enum edn::query::OrWhereClause'>OrWhereClause</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.PatternNonValuePlace.html"
title='enum edn::query::PatternNonValuePlace'>PatternNonValuePlace</a></td>
<td class='docblock-short'>
<p>e, a, tx can't be values -- no strings, no floats -- and so
they can only be variables, entity IDs, ident keywords, or
placeholders.
This encoding allows us to represent integers that aren't
entity IDs. That'll get filtered out in the context of the
database.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.PatternValuePlace.html"
title='enum edn::query::PatternValuePlace'>PatternValuePlace</a></td>
<td class='docblock-short'>
<p>The <code>v</code> part of a pattern can be much broader: it can represent
integers that aren't entity IDs (particularly negative integers),
strings, and all the rest. We group those under <code>Constant</code>.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.PullAttributeSpec.html"
title='enum edn::query::PullAttributeSpec'>PullAttributeSpec</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.PullConcreteAttribute.html"
title='enum edn::query::PullConcreteAttribute'>PullConcreteAttribute</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.SrcVar.html"
title='enum edn::query::SrcVar'>SrcVar</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.UnifyVars.html"
title='enum edn::query::UnifyVars'>UnifyVars</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.VariableOrPlaceholder.html"
title='enum edn::query::VariableOrPlaceholder'>VariableOrPlaceholder</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.WhereClause.html"
title='enum edn::query::WhereClause'>WhereClause</a></td>
<td class='docblock-short'>
</td>
</tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
<table>
<tr class=' module-item'>
<td><a class="trait" href="trait.ContainsVariables.html"
title='trait edn::query::ContainsVariables'>ContainsVariables</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="trait" href="trait.FromValue.html"
title='trait edn::query::FromValue'>FromValue</a></td>
<td class='docblock-short'>
</td>
</tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
<table>
<tr class=' module-item'>
<td><a class="type" href="type.SrcVarName.html"
title='type edn::query::SrcVarName'>SrcVarName</a></td>
<td class='docblock-short'>
</td>
</tr></table></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>