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
293 lines
13 KiB
HTML
293 lines
13 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<title>RelResult 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/RelResult" class="dashAnchor"></a>
|
|
<a title="RelResult 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" />
|
|
RelResult 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>RelResult</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">RelResult</span> <span class="p">:</span> <span class="kt"><a href="../Classes/OptionalRustObject.html">OptionalRustObject</a></span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<p>Wraps a <code>Rel</code> result from a Mentat query.
|
|
A <code>Rel</code> result is a list of rows of <code>TypedValues</code>.
|
|
Individual rows can be fetched or the set can be iterated.</p>
|
|
|
|
<p>To fetch individual rows from a <code>RelResult</code> use <code>row(Int32)</code>.</p>
|
|
<pre class="highlight swift"><code><span class="n">query</span><span class="o">.</span><span class="n">run</span> <span class="p">{</span> <span class="n">rows</span> <span class="k">in</span>
|
|
<span class="k">let</span> <span class="nv">row1</span> <span class="o">=</span> <span class="n">rows</span><span class="o">.</span><span class="nf">row</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
|
|
<span class="k">let</span> <span class="nv">row2</span> <span class="o">=</span> <span class="n">rows</span><span class="o">.</span><span class="nf">row</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
|
|
<span class="p">}</span>
|
|
</code></pre>
|
|
|
|
<p>To iterate over the result set use standard iteration flows.</p>
|
|
<pre class="highlight swift"><code><span class="n">query</span><span class="o">.</span><span class="n">run</span> <span class="p">{</span> <span class="n">rows</span> <span class="k">in</span>
|
|
<span class="n">rows</span><span class="o">.</span><span class="n">forEach</span> <span class="p">{</span> <span class="n">row</span> <span class="k">in</span>
|
|
<span class="o">...</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
</code></pre>
|
|
|
|
<p>Note that iteration is consuming and can only be done once.</p>
|
|
|
|
</section>
|
|
<section class="section task-group-section">
|
|
<div class="task-group">
|
|
<ul>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:6Mentat9RelResultC3rowAA05TupleC0CSgs5Int32V5index_tKF"></a>
|
|
<a name="//apple_ref/swift/Method/row(index:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:6Mentat9RelResultC3rowAA05TupleC0CSgs5Int32V5index_tKF">row(index:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Fetch the row at the requested index.</p>
|
|
<div class="aside aside-throws">
|
|
<p class="aside-title">Throws</p>
|
|
<p><code><a href="../Enums/PointerError.html#/s:6Mentat12PointerErrorO15pointerConsumedA2CmF">PointerError.pointerConsumed</a></code> if the result set has already been iterated.</p>
|
|
|
|
</div>
|
|
|
|
</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">row</span><span class="p">(</span><span class="nv">index</span><span class="p">:</span> <span class="kt">Int32</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-></span> <span class="kt"><a href="../Classes/TupleResult.html">TupleResult</a></span><span class="p">?</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h4>Parameters</h4>
|
|
<table class="graybox">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>index</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>the index of the row to be fetched</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h4>Return Value</h4>
|
|
<p>The row at the requested index as a <code><a href="../Classes/TupleResult.html">TupleResult</a></code>, if present, or nil if there is no row at that index.</p>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:6Mentat9RelResultC7cleanupys13OpaquePointerV7pointer_tF"></a>
|
|
<a name="//apple_ref/swift/Method/cleanup(pointer:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:6Mentat9RelResultC7cleanupys13OpaquePointerV7pointer_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>
|
|
<div class="task-group">
|
|
<ul>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:s8SequenceP12makeIterator0C0QzyF"></a>
|
|
<a name="//apple_ref/swift/Method/makeIterator()" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:s8SequenceP12makeIterator0C0QzyF">makeIterator()</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
|
|
</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">makeIterator</span><span class="p">()</span> <span class="o">-></span> <span class="kt"><a href="../Classes/RelResultIterator.html">RelResultIterator</a></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>
|