309 lines
14 KiB
HTML
309 lines
14 KiB
HTML
|
<!DOCTYPE html>
|
||
|
|
<html lang="en">
|
||
|
|
<head>
|
||
|
|
<title>TxReport Class Reference</title>
|
||
|
|
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
|
||
|
|
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
|
||
|
|
<meta charset='utf-8'>
|
||
|
|
<script src="../js/jquery.min.js" defer></script>
|
||
|
|
<script src="../js/jazzy.js" defer></script>
|
||
|
|
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<a name="//apple_ref/swift/Class/TxReport" class="dashAnchor"></a>
|
||
|
|
<a title="TxReport Class Reference"></a>
|
||
|
|
<header>
|
||
|
|
<div class="content-wrapper">
|
||
|
|
<p><a href="../index.html"> Docs</a> (74% documented)</p>
|
||
|
|
</div>
|
||
|
|
</header>
|
||
|
|
<div class="content-wrapper">
|
||
|
|
<p id="breadcrumbs">
|
||
|
|
<a href="../index.html"> Reference</a>
|
||
|
|
<img id="carat" src="../img/carat.png" />
|
||
|
|
TxReport Class Reference
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
<div class="content-wrapper">
|
||
|
|
<nav class="sidebar">
|
||
|
|
<ul class="nav-groups">
|
||
|
|
<li class="nav-group-name">
|
||
|
|
<a href="../Classes.html">Classes</a>
|
||
|
|
<ul class="nav-group-tasks">
|
||
|
|
<li class="nav-group-task">
|
||
|
|
<a href="../Classes/ColResult.html">ColResult</a>
|
||
|
|
</li>
|
||
|
|
<li class="nav-group-task">
|
||
|
|
<a href="../Classes/ColResultIterator.html">ColResultIterator</a>
|
||
|
|
</li>
|
||
|
|
<li class="nav-group-task">
|
||
|
|
<a href="../Classes/EntityBuilder.html">EntityBuilder</a>
|
||
|
|
</li>
|
||
|
|
<li class="nav-group-task">
|
||
|
|
<a href="../Classes/InProgress.html">InProgress</a>
|
||
|
|
</li>
|
||
|
|
<li class="nav-group-task">
|
||
|
|
<a href="../Classes/InProgressBuilder.html">InProgressBuilder</a>
|
||
|
|
</li>
|
||
|
|
<li class="nav-group-task">
|
||
|
|
<a href="../Classes/Mentat.html">Mentat</a>
|
||
|
|
</li>
|
||
|
|
<li class="nav-group-task">
|
||
|
|
<a href="../Classes/OptionalRustObject.html">OptionalRustObject</a>
|
||
|
|
</li>
|
||
|
|
<li class="nav-group-task">
|
||
|
|
<a href="../Classes/Query.html">Query</a>
|
||
|
|
</li>
|
||
|
|
<li class="nav-group-task">
|
||
|
|
<a href="../Classes/RelResult.html">RelResult</a>
|
||
|
|
</li>
|
||
|
|
<li class="nav-group-task">
|
||
|
|
<a href="../Classes/RelResultIterator.html">RelResultIterator</a>
|
||
|
|
</li>
|
||
|
|
<li class="nav-group-task">
|
||
|
|
<a href="../Classes/RustObject.html">RustObject</a>
|
||
|
|
</li>
|
||
|
|
<li class="nav-group-task">
|
||
|
|
<a href="../Classes/TupleResult.html">TupleResult</a>
|
||
|
|
</li>
|
||
|
|
<li class="nav-group-task">
|
||
|
|
<a href="../Classes/TxReport.html">TxReport</a>
|
||
|
|
</li>
|
||
|
|
<li class="nav-group-task">
|
||
|
|
<a href="../Classes/TypedValue.html">TypedValue</a>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="nav-group-name">
|
||
|
|
<a href="../Enums.html">Enumerations</a>
|
||
|
|
<ul class="nav-group-tasks">
|
||
|
|
<li class="nav-group-task">
|
||
|
|
<a href="../Enums/CacheDirection.html">CacheDirection</a>
|
||
|
|
</li>
|
||
|
|
<li class="nav-group-task">
|
||
|
|
<a href="../Enums/PointerError.html">PointerError</a>
|
||
|
|
</li>
|
||
|
|
<li class="nav-group-task">
|
||
|
|
<a href="../Enums/QueryError.html">QueryError</a>
|
||
|
|
</li>
|
||
|
|
<li class="nav-group-task">
|
||
|
|
<a href="../Enums/ResultError.html">ResultError</a>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="nav-group-name">
|
||
|
|
<a href="../Extensions.html">Extensions</a>
|
||
|
|
<ul class="nav-group-tasks">
|
||
|
|
<li class="nav-group-task">
|
||
|
|
<a href="../Extensions/Date.html">Date</a>
|
||
|
|
</li>
|
||
|
|
<li class="nav-group-task">
|
||
|
|
<a href="../Extensions/Result.html">Result</a>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="nav-group-name">
|
||
|
|
<a href="../Protocols.html">Protocols</a>
|
||
|
|
<ul class="nav-group-tasks">
|
||
|
|
<li class="nav-group-task">
|
||
|
|
<a href="../Protocols/Observable.html">Observable</a>
|
||
|
|
</li>
|
||
|
|
<li class="nav-group-task">
|
||
|
|
<a href="../Protocols/Observing.html">Observing</a>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="nav-group-name">
|
||
|
|
<a href="../Structs.html">Structures</a>
|
||
|
|
<ul class="nav-group-tasks">
|
||
|
|
<li class="nav-group-task">
|
||
|
|
<a href="../Structs.html#/s:6Mentat0A5ErrorV">MentatError</a>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="nav-group-name">
|
||
|
|
<a href="../Typealiases.html">Type Aliases</a>
|
||
|
|
<ul class="nav-group-tasks">
|
||
|
|
<li class="nav-group-task">
|
||
|
|
<a href="../Typealiases.html#/s:6Mentat5Entida">Entid</a>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</nav>
|
||
|
|
<article class="main-content">
|
||
|
|
<section>
|
||
|
|
<section class="section">
|
||
|
|
<h1>TxReport</h1>
|
||
|
|
<div class="declaration">
|
||
|
|
<div class="language">
|
||
|
|
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">TxReport</span> <span class="p">:</span> <span class="kt"><a href="../Classes/RustObject.html">RustObject</a></span></code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<p>This class wraps a raw pointer that points to a Rust <code>TxReport</code> object.</p>
|
||
|
|
|
||
|
|
<p>The <code>TxReport</code> contains information about a successful Mentat transaction.</p>
|
||
|
|
|
||
|
|
<p>This information includes:</p>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li><code>txId</code> - the identifier for the transaction.</li>
|
||
|
|
<li><code>txInstant</code> - the time that the transaction occured.</li>
|
||
|
|
<li>a map of temporary identifiers provided in the transaction and the <code><a href="../Typealiases.html#/s:6Mentat5Entida">Entid</a></code>s that they were mapped to,</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<p>Access an <code><a href="../Typealiases.html#/s:6Mentat5Entida">Entid</a></code> for a temporary identifier that was provided in the transaction can be done through <code>entid(String:)</code>.</p>
|
||
|
|
<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">report</span> <span class="o">=</span> <span class="n">mentat</span><span class="o">.</span><span class="nf">transact</span><span class="p">(</span><span class="s">"[[:db/add "</span><span class="n">a</span><span class="s">" :foo/boolean true]]"</span><span class="p">)</span>
|
||
|
|
<span class="k">let</span> <span class="nv">aEntid</span> <span class="o">=</span> <span class="n">report</span><span class="o">.</span><span class="nf">entid</span><span class="p">(</span><span class="nv">forTempId</span><span class="p">:</span> <span class="s">"a"</span><span class="p">)</span>
|
||
|
|
</code></pre>
|
||
|
|
|
||
|
|
</section>
|
||
|
|
<section class="section task-group-section">
|
||
|
|
<div class="task-group">
|
||
|
|
<ul>
|
||
|
|
<li class="item">
|
||
|
|
<div>
|
||
|
|
<code>
|
||
|
|
<a name="/s:6Mentat8TxReportC4txIds5Int64Vvp"></a>
|
||
|
|
<a name="//apple_ref/swift/Property/txId" class="dashAnchor"></a>
|
||
|
|
<a class="token" href="#/s:6Mentat8TxReportC4txIds5Int64Vvp">txId</a>
|
||
|
|
</code>
|
||
|
|
</div>
|
||
|
|
<div class="height-container">
|
||
|
|
<div class="pointer-container"></div>
|
||
|
|
<section class="section">
|
||
|
|
<div class="pointer"></div>
|
||
|
|
<div class="abstract">
|
||
|
|
<p>Undocumented</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="declaration">
|
||
|
|
<h4>Declaration</h4>
|
||
|
|
<div class="language">
|
||
|
|
<p class="aside-title">Swift</p>
|
||
|
|
<pre class="highlight swift"><code><span class="kd">open</span> <span class="k">var</span> <span class="nv">txId</span><span class="p">:</span> <span class="kt"><a href="../Typealiases.html#/s:6Mentat5Entida">Entid</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
</div>
|
||
|
|
</li>
|
||
|
|
<li class="item">
|
||
|
|
<div>
|
||
|
|
<code>
|
||
|
|
<a name="/s:6Mentat8TxReportC9txInstant10Foundation4DateVvp"></a>
|
||
|
|
<a name="//apple_ref/swift/Property/txInstant" class="dashAnchor"></a>
|
||
|
|
<a class="token" href="#/s:6Mentat8TxReportC9txInstant10Foundation4DateVvp">txInstant</a>
|
||
|
|
</code>
|
||
|
|
</div>
|
||
|
|
<div class="height-container">
|
||
|
|
<div class="pointer-container"></div>
|
||
|
|
<section class="section">
|
||
|
|
<div class="pointer"></div>
|
||
|
|
<div class="abstract">
|
||
|
|
<p>Undocumented</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="declaration">
|
||
|
|
<h4>Declaration</h4>
|
||
|
|
<div class="language">
|
||
|
|
<p class="aside-title">Swift</p>
|
||
|
|
<pre class="highlight swift"><code><span class="kd">open</span> <span class="k">var</span> <span class="nv">txInstant</span><span class="p">:</span> <span class="kt">Date</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
</div>
|
||
|
|
</li>
|
||
|
|
<li class="item">
|
||
|
|
<div>
|
||
|
|
<code>
|
||
|
|
<a name="/s:6Mentat8TxReportC5entids5Int64VSgSS9forTempId_tF"></a>
|
||
|
|
<a name="//apple_ref/swift/Method/entid(forTempId:)" class="dashAnchor"></a>
|
||
|
|
<a class="token" href="#/s:6Mentat8TxReportC5entids5Int64VSgSS9forTempId_tF">entid(forTempId:)</a>
|
||
|
|
</code>
|
||
|
|
</div>
|
||
|
|
<div class="height-container">
|
||
|
|
<div class="pointer-container"></div>
|
||
|
|
<section class="section">
|
||
|
|
<div class="pointer"></div>
|
||
|
|
<div class="abstract">
|
||
|
|
<p>Access an <code><a href="../Typealiases.html#/s:6Mentat5Entida">Entid</a></code> for a temporary identifier that was provided in the transaction.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="declaration">
|
||
|
|
<h4>Declaration</h4>
|
||
|
|
<div class="language">
|
||
|
|
<p class="aside-title">Swift</p>
|
||
|
|
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">entid</span><span class="p">(</span><span class="n">forTempId</span> <span class="nv">tempId</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt"><a href="../Typealiases.html#/s:6Mentat5Entida">Entid</a></span><span class="p">?</span></code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<h4>Parameters</h4>
|
||
|
|
<table class="graybox">
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<code>
|
||
|
|
<em>tempId</em>
|
||
|
|
</code>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<div>
|
||
|
|
<p>A <code>String</code> representing the temporary identifier to fetch the <code><a href="../Typealiases.html#/s:6Mentat5Entida">Entid</a></code> for.</p>
|
||
|
|
</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<h4>Return Value</h4>
|
||
|
|
<p>The <code><a href="../Typealiases.html#/s:6Mentat5Entida">Entid</a></code> for the temporary identifier, if present, otherwise <code>nil</code>.</p>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
</div>
|
||
|
|
</li>
|
||
|
|
<li class="item">
|
||
|
|
<div>
|
||
|
|
<code>
|
||
|
|
<a name="/s:6Mentat8TxReportC7cleanupys13OpaquePointerV7pointer_tF"></a>
|
||
|
|
<a name="//apple_ref/swift/Method/cleanup(pointer:)" class="dashAnchor"></a>
|
||
|
|
<a class="token" href="#/s:6Mentat8TxReportC7cleanupys13OpaquePointerV7pointer_tF">cleanup(pointer:)</a>
|
||
|
|
</code>
|
||
|
|
</div>
|
||
|
|
<div class="height-container">
|
||
|
|
<div class="pointer-container"></div>
|
||
|
|
<section class="section">
|
||
|
|
<div class="pointer"></div>
|
||
|
|
<div class="abstract">
|
||
|
|
<p>Undocumented</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="declaration">
|
||
|
|
<h4>Declaration</h4>
|
||
|
|
<div class="language">
|
||
|
|
<p class="aside-title">Swift</p>
|
||
|
|
<pre class="highlight swift"><code><span class="k">override</span> <span class="kd">open</span> <span class="kd">func</span> <span class="nf">cleanup</span><span class="p">(</span><span class="nv">pointer</span><span class="p">:</span> <span class="kt">OpaquePointer</span><span class="p">)</span></code></pre>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
</div>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
<section id="footer">
|
||
|
|
<p>© 2018 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2018-06-21)</p>
|
||
|
|
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||
|
|
</section>
|
||
|
|
</article>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</div>
|
||
|
|
</html>
|