mentat/mentat_db/debug/index.html
2018-08-22 17:04:13 +00:00

234 lines
No EOL
11 KiB
HTML
Raw Permalink 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 `debug` mod in crate `mentat_db`.">
<meta name="keywords" content="rust, rustlang, rust-lang, debug">
<title>mentat_db::debug - 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'>Module debug</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../index.html'>mentat_db</a></p><script>window.sidebarCurrent = {name: 'debug', 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=''>debug</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_db/debug.rs.html#11-464' 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.Datom.html"
title='struct mentat_db::debug::Datom'>Datom</a></td>
<td class='docblock-short'>
<p>Represents a <em>datom</em> (assertion) in the store.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Datoms.html"
title='struct mentat_db::debug::Datoms'>Datoms</a></td>
<td class='docblock-short'>
<p>Represents a set of datoms (assertions) in the store.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.FulltextValues.html"
title='struct mentat_db::debug::FulltextValues'>FulltextValues</a></td>
<td class='docblock-short'>
<p>Represents the fulltext values in the store.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.TempIds.html"
title='struct mentat_db::debug::TempIds'>TempIds</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.TestConn.html"
title='struct mentat_db::debug::TestConn'>TestConn</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Transactions.html"
title='struct mentat_db::debug::Transactions'>Transactions</a></td>
<td class='docblock-short'>
<p>Represents an ordered sequence of transactions in the store.</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.datoms.html"
title='fn mentat_db::debug::datoms'>datoms</a></td>
<td class='docblock-short'>
<p>Return the set of datoms in the store, ordered by (e, a, v, tx), but not including any datoms of
the form [... :db/txInstant ...].</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.datoms_after.html"
title='fn mentat_db::debug::datoms_after'>datoms_after</a></td>
<td class='docblock-short'>
<p>Return the set of datoms in the store with transaction ID strictly greater than the given <code>tx</code>,
ordered by (e, a, v, tx).</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.dump_sql_query.html"
title='fn mentat_db::debug::dump_sql_query'>dump_sql_query</a></td>
<td class='docblock-short'>
<p>Execute the given <code>sql</code> query with the given <code>params</code> and format the results as a
tab-and-newline formatted string suitable for debug printing.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.fulltext_values.html"
title='fn mentat_db::debug::fulltext_values'>fulltext_values</a></td>
<td class='docblock-short'>
<p>Return the set of fulltext values in the store, ordered by rowid.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.tempids.html"
title='fn mentat_db::debug::tempids'>tempids</a></td>
<td class='docblock-short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.to_entid.html"
title='fn mentat_db::debug::to_entid'>to_entid</a></td>
<td class='docblock-short'>
<p>Convert a numeric entid to an ident <code>Entid</code> if possible, otherwise a numeric <code>Entid</code>.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.transactions_after.html"
title='fn mentat_db::debug::transactions_after'>transactions_after</a></td>
<td class='docblock-short'>
<p>Return the sequence of transactions in the store with transaction ID strictly greater than the
given <code>tx</code>, ordered by (tx, e, a, v).</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 = "mentat_db";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>