dnrops
/
CSV
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
CSV/docs/docsets/.docset/Contents/Resources/Documents/Classes/CSVCodingOptions.html

289 lines
14 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<title>CSVCodingOptions 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/CSVCodingOptions" class="dashAnchor"></a>
<a title="CSVCodingOptions Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html"> Docs</a> (100% documented)</p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="../index.html"> Reference</a>
<img id="carat" src="../img/carat.png" />
CSVCodingOptions 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/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/Optional.html">Optional</a>
</li>
<li class="nav-group-task">
<a href="../Extensions/String.html">String</a>
</li>
<li class="nav-group-task">
<a href="../Extensions/UInt8.html">UInt8</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/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>CSVCodingOptions</h1>
<div class="declaration">
<div class="language">
<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>
<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>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:3CSV16CSVCodingOptionsC7defaultACvpZ"></a>
<a name="//apple_ref/swift/Variable/default" class="dashAnchor"></a>
<a class="token" href="#/s:3CSV16CSVCodingOptionsC7defaultACvpZ">default</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The default coding options.</p>
<p>This option set uses <code>.string</code> for the <code><a href="../Enums/BoolCodingStrategy.html">BoolCodingStrategy</a></code> and <code>.blank</code> for
the <code><a href="../Enums/NilCodingStrategy.html">NilCodingStrategy</a></code>. This means <code>Bool</code> will be represented the value&rsquo;s textual name
and <code>nil</code> will be an empty cell.</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">public</span> <span class="kd">static</span> <span class="kd">let</span> <span class="p">`</span><span class="nv">default</span><span class="p">`</span> <span class="o">=</span> <span class="kt">CSVCodingOptions</span><span class="p">(</span><span class="nv">boolCodingStrategy</span><span class="p">:</span> <span class="o">.</span><span class="n">string</span><span class="p">,</span> <span class="nv">nilCodingStrategy</span><span class="p">:</span> <span class="o">.</span><span class="n">blank</span><span class="p">)</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:3CSV16CSVCodingOptionsC18boolCodingStrategyAA04BooleF0Ovp"></a>
<a name="//apple_ref/swift/Property/boolCodingStrategy" class="dashAnchor"></a>
<a class="token" href="#/s:3CSV16CSVCodingOptionsC18boolCodingStrategyAA04BooleF0Ovp">boolCodingStrategy</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The bool encoding/decoding strategy used for the encoder/decoder the option set is passed to.</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">public</span> <span class="k">var</span> <span class="nv">boolCodingStrategy</span><span class="p">:</span> <span class="kt"><a href="../Enums/BoolCodingStrategy.html">BoolCodingStrategy</a></span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:3CSV16CSVCodingOptionsC17nilCodingStrategyAA03NileF0Ovp"></a>
<a name="//apple_ref/swift/Property/nilCodingStrategy" class="dashAnchor"></a>
<a class="token" href="#/s:3CSV16CSVCodingOptionsC17nilCodingStrategyAA03NileF0Ovp">nilCodingStrategy</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The nil encoding/decoding strategy used for the encoder/decoder the option set is passed to.</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">public</span> <span class="k">var</span> <span class="nv">nilCodingStrategy</span><span class="p">:</span> <span class="kt"><a href="../Enums/NilCodingStrategy.html">NilCodingStrategy</a></span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:3CSV16CSVCodingOptionsC18boolCodingStrategy03nileF0AcA04BooleF0O_AA03NileF0Otcfc"></a>
<a name="//apple_ref/swift/Method/init(boolCodingStrategy:nilCodingStrategy:)" class="dashAnchor"></a>
<a class="token" href="#/s:3CSV16CSVCodingOptionsC18boolCodingStrategy03nileF0AcA04BooleF0O_AA03NileF0Otcfc">init(boolCodingStrategy:nilCodingStrategy:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Creates a new <code>CSVCodingOptions</code> instance.</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">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">boolCodingStrategy</span><span class="p">:</span> <span class="kt"><a href="../Enums/BoolCodingStrategy.html">BoolCodingStrategy</a></span><span class="p">,</span> <span class="nv">nilCodingStrategy</span><span class="p">:</span> <span class="kt"><a href="../Enums/NilCodingStrategy.html">NilCodingStrategy</a></span><span class="p">)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>boolCodingStrategy</em>
</code>
</td>
<td>
<div>
<p>The bool encoding/decoding strategy used for the encoder/decoder the option set is passed to.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>nilCodingStrategy</em>
</code>
</td>
<td>
<div>
<p>The nil encoding/decoding strategy used for the encoder/decoder the option set is passed to.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 2019 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2019-04-19)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</div>
</html>
Reference in New Issue View Git Blame Copy Permalink