357 lines
16 KiB
HTML
357 lines
16 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<title>Config Structure 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/Struct/Config" class="dashAnchor"></a>
|
|
<a title="Config Structure 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=""/>
|
|
Config Structure 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>Config</h1>
|
|
<div class="declaration">
|
|
<div class="language">
|
|
|
|
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">Config</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<p>The <code>Config</code> struct allows for configuring <code><a href="../Structs/Parser.html">Parser</a></code> and <code><a href="../Structs/Serializer.html">Serializer</a></code>
|
|
to allow for separators other than comma or string delimiters
|
|
like quotation marks</p>
|
|
|
|
</section>
|
|
<section class="section task-group-section">
|
|
<div class="task-group">
|
|
<ul>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:3CSV6ConfigV13cellSeparators5UInt8Vvp"></a>
|
|
<a name="//apple_ref/swift/Property/cellSeparator" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:3CSV6ConfigV13cellSeparators5UInt8Vvp">cellSeparator</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>The character that separates one cell from another.</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">let</span> <span class="nv">cellSeparator</span><span class="p">:</span> <span class="kt">UInt8</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:3CSV6ConfigV13cellDelimiters5UInt8VSgvp"></a>
|
|
<a name="//apple_ref/swift/Property/cellDelimiter" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:3CSV6ConfigV13cellDelimiters5UInt8VSgvp">cellDelimiter</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>The character that is used to denote the start and end of a cell’s contents.</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">let</span> <span class="nv">cellDelimiter</span><span class="p">:</span> <span class="kt">UInt8</span><span class="p">?</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:3CSV6ConfigV7defaultACvpZ"></a>
|
|
<a name="//apple_ref/swift/Variable/default" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:3CSV6ConfigV7defaultACvpZ">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 deault <code>Config</code> instance that uses commas for cell separators and double quotes
|
|
for cell delimiters.</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="kt">Config</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:3CSV6ConfigV13cellSeparator0C9DelimiterACs5UInt8V_AGSgtcfc"></a>
|
|
<a name="//apple_ref/swift/Method/init(cellSeparator:cellDelimiter:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:3CSV6ConfigV13cellSeparator0C9DelimiterACs5UInt8V_AGSgtcfc">init(cellSeparator:<wbr>cellDelimiter:<wbr>)</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>Config</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">cellSeparator</span><span class="p">:</span> <span class="kt">UInt8</span><span class="p">,</span> <span class="nv">cellDelimiter</span><span class="p">:</span> <span class="kt">UInt8</span><span class="p">?)</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h4>Parameters</h4>
|
|
<table class="graybox">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>cellSeparator</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The character that separates one cell from another.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>cellDelimiter</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The character that is used to denote the start and end of a cell’s contents.</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:3CSV6ConfigV9separator9delimiterACs7UnicodeO6ScalarV_AItcfc"></a>
|
|
<a name="//apple_ref/swift/Method/init(separator:delimiter:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:3CSV6ConfigV9separator9delimiterACs7UnicodeO6ScalarV_AItcfc">init(separator:<wbr>delimiter:<wbr>)</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>Config</code> instance from <code>UnicdeScalar</code> literals.</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">separator</span><span class="p">:</span> <span class="kt">UnicodeScalar</span><span class="p">,</span> <span class="nv">delimiter</span><span class="p">:</span> <span class="kt">UnicodeScalar</span><span class="p">)</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h4>Parameters</h4>
|
|
<table class="graybox">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>separator</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The <code>UnicodeScalar</code> for the separator between cells (<code>','</code>).</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>delimiter</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The <code>UnicdeScalar</code> for the delimiter that marks the start and end of a cell (<code>'"'</code>).</p>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</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>
|