json/docs/Enums/JSON/CodingKeys.html

263 lines
12 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html lang="en">
<head>
<title>CodingKeys 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>
</head>
<body>
<a name="//apple_ref/swift/Struct/CodingKeys" class="dashAnchor"></a>
<a title="CodingKeys Structure 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" />
CodingKeys 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/JSONCoder.html">JSONCoder</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/JSON.html">JSON</a>
</li>
<li class="nav-group-task">
<a href="../../Enums/JSON/CodingKeys.html"> CodingKeys</a>
</li>
<li class="nav-group-task">
<a href="../../Enums/Number.html">Number</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/Bool.html">Bool</a>
</li>
<li class="nav-group-task">
<a href="../../Extensions/Decodable.html">Decodable</a>
</li>
<li class="nav-group-task">
<a href="../../Extensions/Dictionary.html">Dictionary</a>
</li>
<li class="nav-group-task">
<a href="../../Extensions/Double.html">Double</a>
</li>
<li class="nav-group-task">
<a href="../../Extensions/Encodable.html">Encodable</a>
</li>
<li class="nav-group-task">
<a href="../../Extensions/Float.html">Float</a>
</li>
<li class="nav-group-task">
<a href="../../Extensions/Int.html">Int</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="../../Functions.html">Functions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../../Functions.html#/s:4JSON2leoiyyxz_A2AOSgtKSeRzlF">&lt;=(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="../../Functions.html#/s:4JSON2leoiyyxz_xSgtlF">&lt;=(_:_:)</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/FailableJSONRepresentable.html">FailableJSONRepresentable</a>
</li>
<li class="nav-group-task">
<a href="../../Protocols/LosslessJSONConvertible.html">LosslessJSONConvertible</a>
</li>
<li class="nav-group-task">
<a href="../../Protocols/SafeJSONRepresentable.html">SafeJSONRepresentable</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:4JSON17JSONRepresentablea">JSONRepresentable</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<h1>CodingKeys</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">CodingKeys</span><span class="p">:</span> <span class="kt">CodingKey</span></code></pre>
</div>
</div>
<p>A generic <code>CodingKey</code> type that supports any value.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:4JSONAAO10CodingKeysV11stringValueSSvp"></a>
<a name="//apple_ref/swift/Property/stringValue" class="dashAnchor"></a>
<a class="token" href="#/s:4JSONAAO10CodingKeysV11stringValueSSvp">stringValue</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>See <code>CodingKey.stringValue</code>.</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">stringValue</span><span class="p">:</span> <span class="kt">String</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:4JSONAAO10CodingKeysV8intValueSiSgvp"></a>
<a name="//apple_ref/swift/Property/intValue" class="dashAnchor"></a>
<a class="token" href="#/s:4JSONAAO10CodingKeysV8intValueSiSgvp">intValue</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>See <code>CodingKey.intValue</code>.</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">intValue</span><span class="p">:</span> <span class="kt">Int</span><span class="p">?</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:4JSONAAO10CodingKeysV11stringValueADSS_tcfc"></a>
<a name="//apple_ref/swift/Method/init(stringValue:)" class="dashAnchor"></a>
<a class="token" href="#/s:4JSONAAO10CodingKeysV11stringValueADSS_tcfc">init(stringValue:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>See <code>CodingKey.init(stringValue:)</code>.</p>
<p>If the string passed in is convertible to an <code>Int</code>, the <code><a href="../../Enums/JSON/CodingKeys.html#/s:4JSONAAO10CodingKeysV8intValueSiSgvp">intValue</a></code> property is set.</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">stringValue</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:4JSONAAO10CodingKeysV8intValueADSi_tcfc"></a>
<a name="//apple_ref/swift/Method/init(intValue:)" class="dashAnchor"></a>
<a class="token" href="#/s:4JSONAAO10CodingKeysV8intValueADSi_tcfc">init(intValue:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>See <code>CodingKey.init(intValue:)</code>.</p>
<p>The <code><a href="../../Enums/JSON/CodingKeys.html#/s:4JSONAAO10CodingKeysV11stringValueSSvp">.stringValue</a></code> property is set to the string representation of the <code>Int</code>.</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">intValue</span><span class="p">:</span> <span class="kt">Int</span><span class="p">)</span></code></pre>
</div>
</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-03-27)</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>