mirror of
https://github.com/krzysztofzablocki/Sourcery.git
synced 2026-04-07 19:17:40 +00:00
Lars
496 lines
33 KiB
HTML
496 lines
33 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en">
|
||
<head>
|
||
<title>Codable 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 title="Codable Reference"></a>
|
||
<header>
|
||
<div class="content-wrapper">
|
||
<p><a href="index.html">Sourcery 2.3.0 Docs</a> (100% documented)</p>
|
||
<p class="header-right"><a href="https://github.com/krzysztofzablocki/Sourcery"><img src="img/gh.png"/>View on GitHub</a></p>
|
||
<p class="header-right">
|
||
<form role="search" action="search.json">
|
||
<input type="text" placeholder="Search documentation" data-typeahead>
|
||
</form>
|
||
</p>
|
||
</div>
|
||
</header>
|
||
<div class="content-wrapper">
|
||
<p id="breadcrumbs">
|
||
<a href="index.html">Sourcery Reference</a>
|
||
<img id="carat" src="img/carat.png" />
|
||
Codable Reference
|
||
</p>
|
||
</div>
|
||
<div class="content-wrapper">
|
||
<nav class="sidebar">
|
||
<ul class="nav-groups">
|
||
<li class="nav-group-name">
|
||
<a href="Guides.html">Guides</a>
|
||
<ul class="nav-group-tasks">
|
||
<li class="nav-group-task">
|
||
<a href="installing.html">Installing</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="usage.html">Usage</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="writing-templates.html">Writing templates</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="nav-group-name">
|
||
<a href="Examples.html">Examples</a>
|
||
<ul class="nav-group-tasks">
|
||
<li class="nav-group-task">
|
||
<a href="equatable.html">Equatable</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="hashable.html">Hashable</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="enum-cases.html">Enum cases</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="lenses.html">Lenses</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="mocks.html">Mocks</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="codable.html">Codable</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Protocols/Diffable.html">Diffable</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="diffable.html">Diffable</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="linuxmain.html">LinuxMain</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="decorator.html">Decorator</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="nav-group-name">
|
||
<a href="Types.html">Types</a>
|
||
<ul class="nav-group-tasks">
|
||
<li class="nav-group-task">
|
||
<a href="Classes/Types.html">Types</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Classes/Type.html">Type</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Classes/Protocol.html">Protocol</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Classes/Class.html">Class</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Classes/Struct.html">Struct</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Classes/Enum.html">Enum</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Classes/EnumCase.html">EnumCase</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Classes/AssociatedValue.html">AssociatedValue</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Classes/AssociatedType.html">AssociatedType</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Classes/Variable.html">Variable</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Classes/Method.html">Method</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Classes/MethodParameter.html">MethodParameter</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Classes/Subscript.html">Subscript</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Classes/TypeName.html">TypeName</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Classes/TupleType.html">TupleType</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Classes/TupleElement.html">TupleElement</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Classes/ArrayType.html">ArrayType</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Classes/DictionaryType.html">DictionaryType</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Classes/ClosureType.html">ClosureType</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Classes/GenericType.html">GenericType</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Classes/GenericTypeParameter.html">GenericTypeParameter</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Classes/Attribute.html">Attribute</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Classes/ProtocolComposition.html">ProtocolComposition</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="nav-group-name">
|
||
<a href="Other%20Classes.html">Other Classes</a>
|
||
<ul class="nav-group-tasks">
|
||
<li class="nav-group-task">
|
||
<a href="Classes/Actor.html">Actor</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Classes/ClosureParameter.html">ClosureParameter</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Classes/DiffableResult.html">DiffableResult</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Classes/GenericParameter.html">GenericParameter</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Classes/GenericRequirement.html">GenericRequirement</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Classes/GenericRequirement/Relationship.html">– Relationship</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Classes/Import.html">Import</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Classes/Modifier.html">Modifier</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Classes/SetType.html">SetType</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="nav-group-name">
|
||
<a href="Other%20Enums.html">Other Enumerations</a>
|
||
<ul class="nav-group-tasks">
|
||
<li class="nav-group-task">
|
||
<a href="Enums/Composer.html">Composer</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="nav-group-name">
|
||
<a href="Other%20Extensions.html">Other 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="Other%20Extensions.html#/c:@M@SourceryRuntime@objc(cs)BytesRange">BytesRange</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Other%20Extensions.html#/c:@M@SourceryRuntime@objc(cs)FileParserResult">FileParserResult</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Extensions/String.html">String</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Extensions/StringProtocol.html">StringProtocol</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Extensions/Typealias.html">Typealias</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="nav-group-name">
|
||
<a href="Other%20Protocols.html">Other Protocols</a>
|
||
<ul class="nav-group-tasks">
|
||
<li class="nav-group-task">
|
||
<a href="Protocols/Annotated.html">Annotated</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Protocols/Definition.html">Definition</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Protocols/Documented.html">Documented</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Protocols/Typed.html">Typed</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="nav-group-name">
|
||
<a href="Other%20Typealiases.html">Other Type Aliases</a>
|
||
<ul class="nav-group-tasks">
|
||
<li class="nav-group-task">
|
||
<a href="Other%20Typealiases.html#/s:15SourceryRuntime11Annotationsa">Annotations</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Other%20Typealiases.html#/s:15SourceryRuntime13Documentationa">Documentation</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="Other%20Typealiases.html#/s:15SourceryRuntime0A8Modifiera">SourceryModifier</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</nav>
|
||
<article class="main-content">
|
||
<section>
|
||
<section class="section">
|
||
|
||
<h2 id='i-want-to-generate-code-codable-code-implementation' class='heading'>I want to generate <code>Codable</code> implementation</h2>
|
||
|
||
<p>This template generates <code>Codable</code> implementation for structs that implement <code>AutoCodable</code>, <code>AutoDecodable</code> or <code>AutoEncodable</code> protocols. You should define these protocols as follows:</p>
|
||
<pre class="highlight swift"><code><span class="kd">protocol</span> <span class="kt">AutoDecodable</span><span class="p">:</span> <span class="kt">Decodable</span> <span class="p">{}</span>
|
||
<span class="kd">protocol</span> <span class="kt">AutoEncodable</span><span class="p">:</span> <span class="kt">Encodable</span> <span class="p">{}</span>
|
||
<span class="kd">protocol</span> <span class="kt">AutoCodable</span><span class="p">:</span> <span class="kt">AutoDecodable</span><span class="p">,</span> <span class="kt">AutoEncodable</span> <span class="p">{}</span>
|
||
</code></pre>
|
||
<h3 id='a-href-https-github-com-krzysztofzablocki-sourcery-blob-master-templates-templates-autocodable-swifttemplate-swift-template-a' class='heading'><a href="https://github.com/krzysztofzablocki/Sourcery/blob/master/Templates/Templates/AutoCodable.swifttemplate">Swift template</a></h3>
|
||
<h3 id='generating-coding-keys' class='heading'>Generating coding keys.</h3>
|
||
|
||
<p>If you have few keys that are not matching default key strategy you have to specify only these keys, all other keys will be generated and inlined by the template: </p>
|
||
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">Person</span><span class="p">:</span> <span class="kt">AutoDecodable</span> <span class="p">{</span>
|
||
<span class="k">let</span> <span class="nv">id</span><span class="p">:</span> <span class="kt">String</span>
|
||
<span class="k">let</span> <span class="nv">firstName</span><span class="p">:</span> <span class="kt">Bool</span>
|
||
<span class="k">let</span> <span class="nv">surname</span><span class="p">:</span> <span class="kt">String</span>
|
||
|
||
<span class="kd">enum</span> <span class="kt">CodingKeys</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="kt">CodingKey</span> <span class="p">{</span>
|
||
<span class="c1">// this is the custom key that you define manually</span>
|
||
<span class="k">case</span> <span class="n">firstName</span> <span class="o">=</span> <span class="s">"first_name"</span>
|
||
|
||
<span class="c1">// sourcery:inline:auto:Person.CodingKeys.AutoCodable</span>
|
||
<span class="c1">// the rest is generated by the template</span>
|
||
<span class="k">case</span> <span class="n">id</span>
|
||
<span class="k">case</span> <span class="n">surname</span>
|
||
<span class="c1">// sourcery:end</span>
|
||
<span class="p">}</span>
|
||
|
||
<span class="p">}</span>
|
||
</code></pre>
|
||
|
||
<p>Computed properties are not encoded by default, but if you define a coding key for computed property, template will generate code that will encode it.</p>
|
||
|
||
<p>If you don’t define any keys manually the template will generate <code>CodingKeys</code> enum with the keys for all stored properties, but only if custom implementation of <code>init(from:)</code> or <code>encode(to:)</code> is needed.</p>
|
||
<h3 id='generating-code-init-from-code-constructor' class='heading'>Generating <code>init(from:)</code> constructor.</h3>
|
||
|
||
<p>Template will generate implementation of <code>init(from:)</code> when needed. You can define additional methods and properties on your type to be used to decode it.</p>
|
||
|
||
<ul>
|
||
<li>method to get decoding container. This is useful if your type needs to be decoded from a nested key(s):</li>
|
||
</ul>
|
||
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">MyStruct</span><span class="p">:</span> <span class="kt">AutoDecodable</span> <span class="p">{</span>
|
||
<span class="k">let</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">Int</span>
|
||
|
||
<span class="kd">enum</span> <span class="kt">CodingKeys</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="kt">CodingKey</span> <span class="p">{</span>
|
||
<span class="k">case</span> <span class="n">nested</span>
|
||
<span class="k">case</span> <span class="n">value</span>
|
||
<span class="p">}</span>
|
||
|
||
<span class="kd">static</span> <span class="kd">func</span> <span class="nf">decodingContainer</span><span class="p">(</span><span class="n">_</span> <span class="nv">decoder</span><span class="p">:</span> <span class="kt">Decoder</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-></span> <span class="kt">KeyedDecodingContainer</span><span class="o"><</span><span class="kt">CodingKeys</span><span class="o">></span> <span class="p">{</span>
|
||
<span class="k">return</span> <span class="k">try</span> <span class="n">decoder</span><span class="o">.</span><span class="nf">container</span><span class="p">(</span><span class="nv">keyedBy</span><span class="p">:</span> <span class="kt">CodingKeys</span><span class="o">.</span><span class="k">self</span><span class="p">)</span>
|
||
<span class="o">.</span><span class="nf">nestedContainer</span><span class="p">(</span><span class="nv">keyedBy</span><span class="p">:</span> <span class="kt">CodingKeys</span><span class="o">.</span><span class="k">self</span><span class="p">,</span> <span class="nv">forKey</span><span class="p">:</span> <span class="o">.</span><span class="n">nested</span><span class="p">)</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
</code></pre>
|
||
|
||
<ul>
|
||
<li>method to decode a property. This is useful if you need to decode some property manually:</li>
|
||
</ul>
|
||
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">MyStruct</span><span class="p">:</span> <span class="kt">AutoDecodable</span> <span class="p">{</span>
|
||
<span class="k">let</span> <span class="nv">myProperty</span><span class="p">:</span> <span class="kt">Int</span>
|
||
|
||
<span class="kd">static</span> <span class="kd">func</span> <span class="nf">decodeMyProperty</span><span class="p">(</span><span class="n">from</span> <span class="nv">container</span><span class="p">:</span> <span class="kt">KeyedDecodingContainer</span><span class="o"><</span><span class="kt">CodingKeys</span><span class="o">></span><span class="p">)</span> <span class="o">-></span> <span class="kt">Int</span><span class="p">?</span> <span class="p">{</span>
|
||
<span class="nf">return</span> <span class="p">(</span><span class="k">try</span><span class="p">?</span> <span class="n">container</span><span class="o">.</span><span class="nf">decode</span><span class="p">(</span><span class="kt">String</span><span class="o">.</span><span class="k">self</span><span class="p">,</span> <span class="nv">forKey</span><span class="p">:</span> <span class="o">.</span><span class="n">myProperty</span><span class="p">))</span><span class="o">.</span><span class="nf">flatMap</span><span class="p">(</span><span class="kt">Int</span><span class="o">.</span><span class="kd">init</span><span class="p">)</span>
|
||
<span class="p">}</span>
|
||
<span class="c1">//or</span>
|
||
<span class="kd">static</span> <span class="kd">func</span> <span class="nf">decodeMyProperty</span><span class="p">(</span><span class="n">from</span> <span class="nv">decoder</span><span class="p">:</span> <span class="kt">Decoder</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-></span> <span class="kt">Int</span> <span class="p">{</span>
|
||
<span class="k">return</span> <span class="k">try</span> <span class="n">decoder</span><span class="o">.</span><span class="nf">container</span><span class="p">(</span><span class="nv">keyedBy</span><span class="p">:</span> <span class="kt">CodingKeys</span><span class="o">.</span><span class="k">self</span><span class="p">)</span>
|
||
<span class="o">.</span><span class="nf">decode</span><span class="p">(</span><span class="kt">Int</span><span class="o">.</span><span class="k">self</span><span class="p">,</span> <span class="nv">forKey</span><span class="p">:</span> <span class="o">.</span><span class="n">myProperty</span><span class="p">)</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
</code></pre>
|
||
|
||
<p>These methods can throw or not and can return optional or non-optional result.</p>
|
||
|
||
<ul>
|
||
<li>default property value. You can define a static variable that will be used as a default value of a property if decoding results in <code>nil</code> value:</li>
|
||
</ul>
|
||
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">MyStruct</span><span class="p">:</span> <span class="kt">AutoDecodable</span> <span class="p">{</span>
|
||
<span class="k">let</span> <span class="nv">myProperty</span><span class="p">:</span> <span class="kt">Int</span>
|
||
|
||
<span class="kd">static</span> <span class="k">let</span> <span class="nv">defaultMyProperty</span><span class="p">:</span> <span class="kt">Int</span> <span class="o">=</span> <span class="mi">0</span>
|
||
<span class="p">}</span>
|
||
</code></pre>
|
||
<h3 id='generating-code-encode-to-code-method' class='heading'>Generating <code>encode(to:)</code> method.</h3>
|
||
|
||
<p>Template will generate implementation of <code>encode(to:)</code> method when needed. You can define additional methods to be used to encode it.</p>
|
||
|
||
<ul>
|
||
<li>method to get encoding container. This is useful if your type needs to be encoded into a nested key(s):</li>
|
||
</ul>
|
||
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">MyStruct</span><span class="p">:</span> <span class="kt">AutoDecodable</span> <span class="p">{</span>
|
||
<span class="k">let</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">Int</span>
|
||
|
||
<span class="kd">enum</span> <span class="kt">CodingKeys</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="kt">CodingKey</span> <span class="p">{</span>
|
||
<span class="k">case</span> <span class="n">nested</span>
|
||
<span class="k">case</span> <span class="n">value</span>
|
||
<span class="p">}</span>
|
||
|
||
<span class="kd">func</span> <span class="nf">encodingContainer</span><span class="p">(</span><span class="n">_</span> <span class="nv">encoder</span><span class="p">:</span> <span class="kt">Encoder</span><span class="p">)</span> <span class="o">-></span> <span class="kt">KeyedEncodingContainer</span><span class="o"><</span><span class="kt">CodingKeys</span><span class="o">></span> <span class="p">{</span>
|
||
<span class="k">var</span> <span class="nv">container</span> <span class="o">=</span> <span class="n">encoder</span><span class="o">.</span><span class="nf">container</span><span class="p">(</span><span class="nv">keyedBy</span><span class="p">:</span> <span class="kt">CodingKeys</span><span class="o">.</span><span class="k">self</span><span class="p">)</span>
|
||
<span class="k">return</span> <span class="n">container</span><span class="o">.</span><span class="nf">nestedContainer</span><span class="p">(</span><span class="nv">keyedBy</span><span class="p">:</span> <span class="kt">CodingKeys</span><span class="o">.</span><span class="k">self</span><span class="p">,</span> <span class="nv">forKey</span><span class="p">:</span> <span class="o">.</span><span class="n">nested</span><span class="p">)</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
</code></pre>
|
||
|
||
<ul>
|
||
<li>method to encode a property. This is useful when you need to manually encode a property:</li>
|
||
</ul>
|
||
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">MyStruct</span><span class="p">:</span> <span class="kt">AutoDecodable</span> <span class="p">{</span>
|
||
<span class="k">let</span> <span class="nv">myProperty</span><span class="p">:</span> <span class="kt">Int</span>
|
||
|
||
<span class="kd">func</span> <span class="nf">encodeMyProperty</span><span class="p">(</span><span class="n">to</span> <span class="nv">container</span><span class="p">:</span> <span class="k">inout</span> <span class="kt">KeyedEncodingContainer</span><span class="o"><</span><span class="kt">CodingKeys</span><span class="o">></span><span class="p">)</span> <span class="p">{</span>
|
||
<span class="k">try</span><span class="p">?</span> <span class="n">container</span><span class="o">.</span><span class="nf">decode</span><span class="p">(</span><span class="kt">String</span><span class="p">(</span><span class="n">myProperty</span><span class="p">),</span> <span class="nv">forKey</span><span class="p">:</span> <span class="o">.</span><span class="n">myProperty</span><span class="p">)</span>
|
||
<span class="p">}</span>
|
||
<span class="c1">//or</span>
|
||
<span class="kd">func</span> <span class="nf">encodeMyProperty</span><span class="p">(</span><span class="n">to</span> <span class="nv">encoder</span><span class="p">:</span> <span class="kt">Encoder</span><span class="p">)</span> <span class="k">throws</span> <span class="p">{</span>
|
||
<span class="k">var</span> <span class="nv">container</span> <span class="o">=</span> <span class="n">encoder</span><span class="o">.</span><span class="nf">container</span><span class="p">(</span><span class="nv">keyedBy</span><span class="p">:</span> <span class="kt">CodingKeys</span><span class="o">.</span><span class="k">self</span><span class="p">)</span>
|
||
<span class="k">try</span> <span class="n">container</span><span class="o">.</span><span class="nf">encode</span><span class="p">(</span><span class="kt">String</span><span class="p">(</span><span class="n">myProperty</span><span class="p">),</span> <span class="nv">forKey</span><span class="p">:</span> <span class="o">.</span><span class="n">myProperty</span><span class="p">)</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
</code></pre>
|
||
|
||
<p>These methods may throw or not. </p>
|
||
|
||
<p>If you need to manually encode computed property and you have defined custom encoding method for it, template will generate a coding key for it too, so you don’t have to define it manually (though you may still need to define it if it needs custom raw value).</p>
|
||
|
||
<ul>
|
||
<li>method to encode any additional values. This is useful when you need to encode computed properties or constant values:</li>
|
||
</ul>
|
||
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">MyStruct</span><span class="p">:</span> <span class="kt">AutoDecodable</span> <span class="p">{</span>
|
||
|
||
<span class="kd">func</span> <span class="nf">encodeAdditionalValues</span><span class="p">(</span><span class="n">to</span> <span class="nv">container</span><span class="p">:</span> <span class="k">inout</span> <span class="kt">KeyedEncodingContainer</span><span class="o"><</span><span class="kt">CodingKeys</span><span class="o">></span><span class="p">)</span> <span class="k">throws</span> <span class="p">{</span>
|
||
<span class="o">...</span>
|
||
<span class="p">}</span>
|
||
<span class="c1">// or</span>
|
||
<span class="kd">func</span> <span class="nf">encodeAdditionalValues</span><span class="p">(</span><span class="n">to</span> <span class="nv">encoder</span><span class="p">:</span> <span class="kt">Encoder</span><span class="p">)</span> <span class="k">throws</span> <span class="p">{</span>
|
||
<span class="o">...</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
</code></pre>
|
||
|
||
<p>This method will be called in the end of generated encoding method.</p>
|
||
|
||
<ul>
|
||
<li>enum <code>SkipEncodingKeys</code> for keys to be skipped during encoding. This is useful when you have stored properties that you don’t want to encode, i.e. constants:</li>
|
||
</ul>
|
||
<pre class="highlight swift"><code> <span class="kd">struct</span> <span class="kt">MyStruct</span><span class="p">:</span> <span class="kt">AutoCodable</span> <span class="p">{</span>
|
||
<span class="k">let</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">Int</span>
|
||
<span class="k">let</span> <span class="nv">skipValue</span><span class="p">:</span> <span class="kt">Int</span>
|
||
|
||
<span class="kd">enum</span> <span class="kt">SkipEncodingKeys</span> <span class="p">{</span>
|
||
<span class="k">case</span> <span class="n">skipValue</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
</code></pre>
|
||
<h3 id='codable-enums' class='heading'>Codable enums</h3>
|
||
|
||
<p>Enums with numeric or string raw values are <code>Codable</code> by default. For enums with no raw value or with associated values template will generate <code>Codable</code> implementation.</p>
|
||
<h4 id='enums-with-no-raw-values-and-no-associated-values' class='heading'>Enums with no raw values and no associated values</h4>
|
||
|
||
<p>For such enums template will generate decoding/encoding code that will expect values in JSON to be exactly the same as cases’ names.</p>
|
||
<pre class="highlight swift"><code><span class="kd">enum</span> <span class="kt">SimpleEnum</span><span class="p">:</span> <span class="kt">AutoDecodable</span> <span class="p">{</span>
|
||
<span class="k">case</span> <span class="n">someCase</span>
|
||
<span class="k">case</span> <span class="n">anotherCase</span>
|
||
<span class="p">}</span>
|
||
</code></pre>
|
||
|
||
<p>For such enum template will generate code that will successfully decode from/encode to JSON of following form:</p>
|
||
<pre class="highlight json"><code><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"value"</span><span class="p">:</span><span class="w"> </span><span class="s2">"someCase"</span><span class="w">
|
||
</span><span class="nl">"anotherValue"</span><span class="p">:</span><span class="w"> </span><span class="s2">"anotherCase"</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span></code></pre>
|
||
|
||
<p>You can define coding keys to change the values:</p>
|
||
<pre class="highlight swift"><code><span class="kd">enum</span> <span class="kt">SimpleEnum</span><span class="p">:</span> <span class="kt">AutoDecodable</span> <span class="p">{</span>
|
||
<span class="k">case</span> <span class="n">someCase</span>
|
||
<span class="k">case</span> <span class="n">anotherCase</span>
|
||
|
||
<span class="kd">enum</span> <span class="kt">CodingKeys</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="kt">CodingKey</span> <span class="p">{</span>
|
||
<span class="k">case</span> <span class="n">someCase</span> <span class="o">=</span> <span class="s">"some_case"</span>
|
||
<span class="k">case</span> <span class="n">anotherCase</span> <span class="o">=</span> <span class="s">"another_case"</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
</code></pre>
|
||
<h4 id='enums-with-assoicated-values' class='heading'>Enums with assoicated values</h4>
|
||
|
||
<p>Template supports two different representations of such enums in JSON format.</p>
|
||
<pre class="highlight swift"><code><span class="kd">enum</span> <span class="kt">SimpleEnum</span><span class="p">:</span> <span class="kt">AutoDecodable</span> <span class="p">{</span>
|
||
<span class="k">case</span> <span class="nf">someCase</span><span class="p">(</span><span class="nv">id</span><span class="p">:</span> <span class="kt">Int</span><span class="p">,</span> <span class="nv">name</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span>
|
||
<span class="k">case</span> <span class="n">anotherCase</span>
|
||
<span class="p">}</span>
|
||
</code></pre>
|
||
|
||
<p>If you define a coding key named <code>enumCaseKey</code> then the template will generate code that will encode/decode enum in/from following format:</p>
|
||
<pre class="highlight json"><code><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"someCase"</span><span class="w"> </span><span class="err">//</span><span class="w"> </span><span class="err">enum</span><span class="w"> </span><span class="err">case</span><span class="w"> </span><span class="err">is</span><span class="w"> </span><span class="err">encoded</span><span class="w"> </span><span class="err">in</span><span class="w"> </span><span class="err">a</span><span class="w"> </span><span class="err">special</span><span class="w"> </span><span class="err">key</span><span class="w">
|
||
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"John"</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span></code></pre>
|
||
|
||
<p>All enum cases associated values must be named.</p>
|
||
|
||
<p>If you don’t define <code>enumCaseKey</code> then the template will generate code that will encode/decode enum in/from following format:</p>
|
||
<pre class="highlight json"><code><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"someCase"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w">
|
||
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"John"</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span></code></pre>
|
||
|
||
<p>Associated values of each enum case must be either all named or all unnamed.
|
||
For cases with unnamed associated values JSON format will use array instead of dictionary for associated values, in the same order in which they are defined:</p>
|
||
<pre class="highlight json"><code><span class="p">{</span><span class="w">
|
||
</span><span class="nl">"someCase"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||
</span><span class="mi">1</span><span class="p">,</span><span class="w">
|
||
</span><span class="s2">"Jhon"</span><span class="w">
|
||
</span><span class="p">]</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span></code></pre>
|
||
|
||
<p>You can use all other customisation methods described for structs to decode/encode enum case associated values individually. </p>
|
||
|
||
</section>
|
||
</section>
|
||
<section id="footer">
|
||
<p>Copyright © 2016-2021 Pixle. All rights reserved.</p>
|
||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="noopener" rel="external">jazzy ♪♫ v0.14.0</a>, a <a class="link" href="https://realm.io" target="_blank" rel="noopener" rel="external">Realm</a> project.</p>
|
||
</section>
|
||
</article>
|
||
</div>
|
||
</body>
|
||
</html>
|