425 lines
22 KiB
HTML
425 lines
22 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<title>Classes 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>
|
|
|
|
<script src="js/lunr.min.js" defer></script>
|
|
<script src="js/typeahead.jquery.js" defer></script>
|
|
<script src="js/jazzy.search.js" defer></script>
|
|
</head>
|
|
<body>
|
|
<a name="//apple_ref/swift/Section/Classes" class="dashAnchor"></a>
|
|
<a title="Classes Reference"></a>
|
|
<header>
|
|
<div class="content-wrapper">
|
|
<p><a href="index.html"> Docs</a> (100% documented)</p>
|
|
<div class="header-right">
|
|
<form role="search" action="search.json">
|
|
<input type="text" placeholder="Search documentation" data-typeahead>
|
|
</form>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="content-wrapper">
|
|
<p id="breadcrumbs">
|
|
<a href="index.html"> Reference</a>
|
|
<img id="carat" src="img/carat.png" alt=""/>
|
|
Classes 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/CSVAsyncDecoder.html">CSVAsyncDecoder</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Classes/CSVAsyncEncoder.html">CSVAsyncEncoder</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Classes/CSVCodingOptions.html">CSVCodingOptions</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Classes/CSVDecoder.html">CSVDecoder</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Classes/CSVEncoder.html">CSVEncoder</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Classes/CSVSyncDecoder.html">CSVSyncDecoder</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Classes/CSVSyncEncoder.html">CSVSyncEncoder</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Classes/SyncParser.html">SyncParser</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/BoolCodingStrategy.html">BoolCodingStrategy</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Enums/NilCodingStrategy.html">NilCodingStrategy</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/Array.html">Array</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Extensions.html#/s:SD">Dictionary</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Extensions/Optional.html">Optional</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Extensions/String.html">String</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/BytesRepresentable.html">BytesRepresentable</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Protocols/KeyedCollection.html">KeyedCollection</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/Config.html">Config</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Structs/ErrorList.html">ErrorList</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Structs/Parser.html">Parser</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Structs/Serializer.html">Serializer</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Structs/SyncSerializer.html">SyncSerializer</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<article class="main-content">
|
|
<section>
|
|
<section class="section">
|
|
<h1>Classes</h1>
|
|
<p>The following classes are available globally.</p>
|
|
|
|
</section>
|
|
<section class="section task-group-section">
|
|
<div class="task-group">
|
|
<ul>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:3CSV10CSVEncoderC"></a>
|
|
<a name="//apple_ref/swift/Class/CSVEncoder" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:3CSV10CSVEncoderC">CSVEncoder</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Encodes Swift types to CSV data.</p>
|
|
|
|
<p>This exampls shows how multiple instances of a <code>Person</code> type will be encoded
|
|
to CSV data. <code>Person</code> conforms to <code>Codable</code>, so it is compatible with both the
|
|
<code>CSVEndocder</code> and <code><a href="Classes/CSVDecoder.html">CSVDecoder</a></code>.</p>
|
|
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">Person</span><span class="p">:</span> <span class="kt">Codable</span> <span class="p">{</span>
|
|
<span class="k">let</span> <span class="nv">firstName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span>
|
|
<span class="k">let</span> <span class="nv">lastName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span>
|
|
<span class="k">let</span> <span class="nv">age</span><span class="p">:</span> <span class="kt">Int</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="k">let</span> <span class="nv">people</span> <span class="o">=</span> <span class="p">[</span>
|
|
<span class="kt">Person</span><span class="p">(</span><span class="nv">firstName</span><span class="p">:</span> <span class="s">"Grace"</span><span class="p">,</span> <span class="nv">lastName</span><span class="p">:</span> <span class="s">"Hopper"</span><span class="p">,</span> <span class="nv">age</span><span class="p">:</span> <span class="mi">113</span><span class="p">),</span>
|
|
<span class="kt">Person</span><span class="p">(</span><span class="nv">firstName</span><span class="p">:</span> <span class="s">"Linus"</span><span class="p">,</span> <span class="nv">lastName</span><span class="p">:</span> <span class="s">"Torvold"</span><span class="p">,</span> <span class="nv">age</span><span class="p">:</span> <span class="mi">50</span><span class="p">)</span>
|
|
<span class="p">]</span>
|
|
|
|
<span class="k">let</span> <span class="nv">data</span> <span class="o">=</span> <span class="k">try</span> <span class="kt">CSVEncoder</span><span class="p">()</span><span class="o">.</span><span class="n">sync</span><span class="o">.</span><span class="nf">encode</span><span class="p">(</span><span class="n">people</span><span class="p">)</span>
|
|
<span class="nf">print</span><span class="p">(</span><span class="kt">String</span><span class="p">(</span><span class="nv">decoding</span><span class="p">:</span> <span class="n">data</span><span class="p">,</span> <span class="nv">as</span><span class="p">:</span> <span class="kt">UTF8</span><span class="o">.</span><span class="k">self</span><span class="p">))</span>
|
|
|
|
<span class="cm">/* Prints:
|
|
"firstName","lastName","age"
|
|
"Grace","Hopper","113"
|
|
"Linus","Torvold","50"
|
|
*/</span>
|
|
</code></pre>
|
|
|
|
<a href="Classes/CSVEncoder.html" class="slightly-smaller">See more</a>
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">CSVEncoder</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:3CSV14CSVSyncEncoderC"></a>
|
|
<a name="//apple_ref/swift/Class/CSVSyncEncoder" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:3CSV14CSVSyncEncoderC">CSVSyncEncoder</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>The encoder for encoding multiple objects at once into a single CSV document.</p>
|
|
|
|
<p>You can get an instance of the <code>CSVSyncEncoder</code> with the <code><a href="Classes/CSVEncoder.html#/s:3CSV10CSVEncoderC4syncAA14CSVSyncEncoderCvp">CSVEncoder.sync</a></code> property.</p>
|
|
|
|
<a href="Classes/CSVSyncEncoder.html" class="slightly-smaller">See more</a>
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">CSVSyncEncoder</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:3CSV15CSVAsyncEncoderC"></a>
|
|
<a name="//apple_ref/swift/Class/CSVAsyncEncoder" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:3CSV15CSVAsyncEncoderC">CSVAsyncEncoder</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>An encoder for encoding multiple objects separately into a single CSV document.</p>
|
|
|
|
<p>You can get an instance of the <code>CSVAsyncEncoder</code> using the <code><a href="Classes/CSVEncoder.html#/s:3CSV10CSVEncoderC5asyncyAA15CSVAsyncEncoderCySays5UInt8VGcF">CSVEncoder.async(_:)</a></code> method.</p>
|
|
|
|
<a href="Classes/CSVAsyncEncoder.html" class="slightly-smaller">See more</a>
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">CSVAsyncEncoder</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:3CSV10CSVDecoderC"></a>
|
|
<a name="//apple_ref/swift/Class/CSVDecoder" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:3CSV10CSVDecoderC">CSVDecoder</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Decodes CSV document data to Swift types.</p>
|
|
|
|
<p>This example shows how a simple <code>Person</code> type will be decoded from a CSV document.
|
|
Person<code>conforms to</code>Codable<code>, so it is compatible with both the</code>CSVEndocder<code>and</code>CSVDecoder`.</p>
|
|
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">Person</span><span class="p">:</span> <span class="kt">Codable</span> <span class="p">{</span>
|
|
<span class="k">let</span> <span class="nv">firstName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span>
|
|
<span class="k">let</span> <span class="nv">lastName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span>
|
|
<span class="k">let</span> <span class="nv">age</span><span class="p">:</span> <span class="kt">Int</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="k">let</span> <span class="nv">csv</span> <span class="o">=</span> <span class="s">"""
|
|
"</span><span class="n">firstName</span><span class="s">","</span><span class="n">lastName</span><span class="s">","</span><span class="n">age</span><span class="s">"
|
|
"</span><span class="kt">Grace</span><span class="s">","</span><span class="kt">Hopper</span><span class="s">","</span><span class="mi">113</span><span class="s">"
|
|
"</span><span class="kt">Linus</span><span class="s">","</span><span class="kt">Torvold</span><span class="s">","</span><span class="mi">50</span><span class="s">"
|
|
"""</span>
|
|
<span class="k">let</span> <span class="nv">data</span> <span class="o">=</span> <span class="kt">Data</span><span class="p">(</span><span class="n">csv</span><span class="o">.</span><span class="n">utf8</span><span class="p">)</span>
|
|
|
|
<span class="k">let</span> <span class="nv">people</span> <span class="o">=</span> <span class="k">try</span> <span class="kt">CSVDecoder</span><span class="o">.</span><span class="n">sync</span><span class="o">.</span><span class="nf">decode</span><span class="p">(</span><span class="kt">Person</span><span class="o">.</span><span class="k">self</span><span class="p">,</span> <span class="nv">from</span><span class="p">:</span> <span class="n">data</span><span class="p">)</span>
|
|
<span class="nf">print</span><span class="p">(</span><span class="n">people</span><span class="o">.</span><span class="n">map</span> <span class="p">{</span> <span class="nv">$0</span><span class="o">.</span><span class="n">firstName</span> <span class="p">})</span> <span class="c1">// Prints: `["Grace","Linus"]`</span>
|
|
</code></pre>
|
|
|
|
<a href="Classes/CSVDecoder.html" class="slightly-smaller">See more</a>
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">CSVDecoder</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:3CSV14CSVSyncDecoderC"></a>
|
|
<a name="//apple_ref/swift/Class/CSVSyncDecoder" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:3CSV14CSVSyncDecoderC">CSVSyncDecoder</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>A decoder for decoding a single CSV document all at once.</p>
|
|
|
|
<p>You can get an instance of <code>CSVSyncDecoder</code> from the <code><a href="Classes/CSVDecoder.html#/s:3CSV10CSVDecoderC4syncAA14CSVSyncDecoderCvp">CSVDecoder.sync</a></code> property.</p>
|
|
|
|
<a href="Classes/CSVSyncDecoder.html" class="slightly-smaller">See more</a>
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">CSVSyncDecoder</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:3CSV15CSVAsyncDecoderC"></a>
|
|
<a name="//apple_ref/swift/Class/CSVAsyncDecoder" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:3CSV15CSVAsyncDecoderC">CSVAsyncDecoder</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>A decoder for decoding sections of a CSV document at different times.</p>
|
|
|
|
<p>You can get an instance of <code>CSVAsyncDecoder</code> from the <code>CSVDecoder.async(for:length_:)</code> method.</p>
|
|
|
|
<a href="Classes/CSVAsyncDecoder.html" class="slightly-smaller">See more</a>
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">CSVAsyncDecoder</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:3CSV16CSVCodingOptionsC"></a>
|
|
<a name="//apple_ref/swift/Class/CSVCodingOptions" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:3CSV16CSVCodingOptionsC">CSVCodingOptions</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>The options used for encoding/decoding certin types in the <code><a href="Classes/CSVEncoder.html">CSVEncoder</a></code> and <code><a href="Classes/CSVDecoder.html">CSVDecoder</a></code>.</p>
|
|
|
|
<a href="Classes/CSVCodingOptions.html" class="slightly-smaller">See more</a>
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">CSVCodingOptions</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:3CSV10SyncParserC"></a>
|
|
<a name="//apple_ref/swift/Class/SyncParser" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:3CSV10SyncParserC">SyncParser</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>A synchronous wrapper for the <code><a href="Structs/Parser.html">Parser</a></code> type for parsing whole CSV documents at once.</p>
|
|
|
|
<a href="Classes/SyncParser.html" class="slightly-smaller">See more</a>
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">SyncParser</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section id="footer">
|
|
<p>© 2021 <a class="link" href="" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2021-10-20)</p>
|
|
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
|
|
</section>
|
|
</article>
|
|
</div>
|
|
</body>
|
|
</html>
|