da599c3a78
* Fix broken API doc links Create symlink for latest to point to v0.7. Group APIs by top version number rather than individual * Update swift and android version numbers to match Mentats * Update documentation * Update top level .gitignore to ignore docs site & metatdata * Add README to help with building documentation site * Address review comments @ncalexan
265 lines
No EOL
12 KiB
HTML
265 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 `types` mod in crate `mentat_db`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, types">
|
||
|
||
<title>mentat_db::types - 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">☰</div>
|
||
|
||
<p class='location'>Module types</p><div class="sidebar-elems"><div class="block items"><ul><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'>mentat_db</a></p><script>window.sidebarCurrent = {name: 'types', 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'>mentat_db</a>::<wbr><a class="mod" href=''>types</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_db/types.rs.html#11-128' title='goto source code'>[src]</a></span></h1><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 mentat_db::types::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.DB.html"
|
||
title='struct mentat_db::types::DB'>DB</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Represents the metadata required to query from, or apply transactions to, a Mentat store.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.DateTime.html"
|
||
title='struct mentat_db::types::DateTime'>DateTime</a></td>
|
||
<td class='docblock-short'>
|
||
<p>ISO 8601 combined date and time with time zone.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.Partition.html"
|
||
title='struct mentat_db::types::Partition'>Partition</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Represents one partition of the entid space.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.Schema.html"
|
||
title='struct mentat_db::types::Schema'>Schema</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Represents a Mentat schema.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.TxReport.html"
|
||
title='struct mentat_db::types::TxReport'>TxReport</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A transaction report summarizes an applied transaction.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.Utc.html"
|
||
title='struct mentat_db::types::Utc'>Utc</a></td>
|
||
<td class='docblock-short'>
|
||
<p>The UTC time zone. This is the most efficient time zone when you don't need the local time.
|
||
It is also used as an offset (which is also a dummy type).</p>
|
||
|
||
</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 mentat_db::types::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.TypedValue.html"
|
||
title='enum mentat_db::types::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 mentat_db::types::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='traits' class='section-header'><a href="#traits">Traits</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="trait" href="trait.TransactableValue.html"
|
||
title='trait mentat_db::types::TransactableValue'>TransactableValue</a></td>
|
||
<td class='docblock-short'>
|
||
<p>The transactor is tied to <code>edn::ValueAndSpan</code> right now, but in the future we'd like to support
|
||
<code>TypedValue</code> directly for programmatic use. <code>TransactableValue</code> encapsulates the interface
|
||
value types (i.e., values in the value place) need to support to be transacted.</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.AVMap.html"
|
||
title='type mentat_db::types::AVMap'>AVMap</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Map [a v] pairs to existing entids.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="type" href="type.AVPair.html"
|
||
title='type mentat_db::types::AVPair'>AVPair</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A pair [a v] in the store.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="type" href="type.AttributeSet.html"
|
||
title='type mentat_db::types::AttributeSet'>AttributeSet</a></td>
|
||
<td class='docblock-short'>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="type" href="type.Entid.html"
|
||
title='type mentat_db::types::Entid'>Entid</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Represents one entid in the entid space.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="type" href="type.PartitionMap.html"
|
||
title='type mentat_db::types::PartitionMap'>PartitionMap</a></td>
|
||
<td class='docblock-short'>
|
||
<p>Map partition names to <code>Partition</code> instances.</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>⏎</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_db";
|
||
</script>
|
||
<script src="../../main.js"></script>
|
||
<script defer src="../../search-index.js"></script>
|
||
</body>
|
||
</html> |