mentat/core_traits/index.html

241 lines
11 KiB
HTML
Raw Normal View History

2018-08-22 17:04:13 +00:00
<!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 `core_traits` crate.">
<meta name="keywords" content="rust, rustlang, rust-lang, core_traits">
<title>core_traits - 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 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'>Crate core_traits</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#macros">Macros</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'core_traits', ty: 'mod', relpath: '../'};</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'>Crate <a class="mod" href=''>core_traits</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/core_traits/lib.rs.html#11-1082' title='goto source code'>[src]</a></span></h1>
<h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
<table>
<tr class=' module-item'>
<td><a class="mod" href="attribute/index.html"
title='mod core_traits::attribute'>attribute</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="values/index.html"
title='mod core_traits::values'>values</a></td>
<td class='docblock-short'>
</td>
</tr></table><h2 id='macros' class='section-header'><a href="#macros">Macros</a></h2>
<table>
<tr class=' module-item'>
<td><a class="macro" href="macro.bail.html"
title='macro core_traits::bail'>bail</a></td>
<td class='docblock-short'>
</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.Attribute.html"
title='struct core_traits::Attribute'>Attribute</a></td>
<td class='docblock-short'>
<p>A Mentat schema attribute has a value type and several other flags determining how assertions
with the attribute are interpreted.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.KnownEntid.html"
title='struct core_traits::KnownEntid'>KnownEntid</a></td>
<td class='docblock-short'>
<p>An entid that's either already in the store, or newly allocated to a tempid.
TODO: we'd like to link this in some way to the lifetime of a particular PartitionMap.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.StructuredMap.html"
title='struct core_traits::StructuredMap'>StructuredMap</a></td>
<td class='docblock-short'>
<p>A pull expression expands a binding into a structure. The returned structure
associates attributes named in the input or retrieved from the store with values.
This association is a <code>StructuredMap</code>.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.ValueTypeSet.html"
title='struct core_traits::ValueTypeSet'>ValueTypeSet</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.AttributeBitFlags.html"
title='enum core_traits::AttributeBitFlags'>AttributeBitFlags</a></td>
<td class='docblock-short'>
<p>Bit flags used in <code>flags0</code> column in temporary tables created during search,
such as the <code>search_results</code>, <code>inexact_searches</code> and <code>exact_searches</code> tables.
When moving to a more concrete table, such as <code>datoms</code>, they are expanded out
via these flags and put into their own column rather than a bit field.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.Binding.html"
title='enum core_traits::Binding'>Binding</a></td>
<td class='docblock-short'>
<p>The values bound in a query specification can be:</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.TypedValue.html"
title='enum core_traits::TypedValue'>TypedValue</a></td>
<td class='docblock-short'>
<p>Represents a value that can be stored in a Mentat store.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.ValueType.html"
title='enum core_traits::ValueType'>ValueType</a></td>
<td class='docblock-short'>
<p>The attribute of each Mentat assertion has a :db/valueType constraining the value to a
particular set. Mentat recognizes the following :db/valueType values.</p>
</td>
</tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
<table>
<tr class=' module-item'>
<td><a class="fn" href="fn.now.html"
title='fn core_traits::now'>now</a></td>
<td class='docblock-short'>
<p>Return the current time as a UTC <code>DateTime</code> instance with microsecond precision.</p>
</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.Entid.html"
title='type core_traits::Entid'>Entid</a></td>
<td class='docblock-short'>
<p>Represents one entid in the entid space.</p>
</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 = "core_traits";
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>