mirror of
https://github.com/krzysztofzablocki/Sourcery.git
synced 2026-04-07 19:17:40 +00:00
Lars
508 lines
24 KiB
HTML
508 lines
24 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en">
|
||
<head>
|
||
<title>Enum 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>
|
||
|
||
<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/Class/Enum" class="dashAnchor"></a>
|
||
<a title="Enum Class 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" />
|
||
Enum Class 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">
|
||
<h1>Enum</h1>
|
||
<div class="declaration">
|
||
<div class="language">
|
||
|
||
<pre class="highlight swift"><code><span class="kd">@objcMembers</span>
|
||
<span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">Enum</span> <span class="p">:</span> <span class="k">Type</span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
<p>Defines Swift enum</p>
|
||
|
||
</section>
|
||
<section class="section task-group-section">
|
||
<div class="task-group">
|
||
<ul>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/c:@M@SourceryRuntime@objc(cs)Enum(cpy)kind"></a>
|
||
<a name="//apple_ref/swift/Variable/kind" class="dashAnchor"></a>
|
||
<a class="token" href="#/c:@M@SourceryRuntime@objc(cs)Enum(cpy)kind">kind</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
|
||
</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">class</span> <span class="k">var</span> <span class="nv">kind</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/c:@M@SourceryRuntime@objc(cs)Enum(py)kind"></a>
|
||
<a name="//apple_ref/swift/Property/kind" class="dashAnchor"></a>
|
||
<a class="token" href="#/c:@M@SourceryRuntime@objc(cs)Enum(py)kind">kind</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
<p>Returns “enum”</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">override</span> <span class="k">var</span> <span class="nv">kind</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/c:@M@SourceryRuntime@objc(cs)Enum(py)cases"></a>
|
||
<a name="//apple_ref/swift/Property/cases" class="dashAnchor"></a>
|
||
<a class="token" href="#/c:@M@SourceryRuntime@objc(cs)Enum(py)cases">cases</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
<p>Enum cases</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">cases</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/EnumCase.html">EnumCase</a></span><span class="p">]</span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/c:@M@SourceryRuntime@objc(cs)Enum(py)rawTypeName"></a>
|
||
<a name="//apple_ref/swift/Property/rawTypeName" class="dashAnchor"></a>
|
||
<a class="token" href="#/c:@M@SourceryRuntime@objc(cs)Enum(py)rawTypeName">rawTypeName</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
<p>Enum raw value type name, if any. This type is removed from enum’s <code><a href="../Classes/Enum.html#/c:@M@SourceryRuntime@objc(cs)Enum(py)based">based</a></code> and <code>inherited</code> types collections.</p>
|
||
<div class="aside aside-important">
|
||
<p class="aside-title">Important</p>
|
||
Unless raw type is specified explicitly via type alias RawValue it will be set to the first type in the inheritance chain.
|
||
So if your enum does not have raw value but implements protocols you’ll have to specify conformance to these protocols via extension to get enum with nil raw value type and all based and inherited types.
|
||
|
||
</div>
|
||
|
||
</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">rawTypeName</span><span class="p">:</span> <span class="kt"><a href="../Classes/TypeName.html">TypeName</a></span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/c:@M@SourceryRuntime@objc(cs)Enum(py)rawType"></a>
|
||
<a name="//apple_ref/swift/Property/rawType" class="dashAnchor"></a>
|
||
<a class="token" href="#/c:@M@SourceryRuntime@objc(cs)Enum(py)rawType">rawType</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
<p>Enum raw value type, if known</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">rawType</span><span class="p">:</span> <span class="k">Type</span><span class="p">?</span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/c:@M@SourceryRuntime@objc(cs)Enum(py)based"></a>
|
||
<a name="//apple_ref/swift/Property/based" class="dashAnchor"></a>
|
||
<a class="token" href="#/c:@M@SourceryRuntime@objc(cs)Enum(py)based">based</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
<p>Names of types or protocols this type inherits from, including unknown (not scanned) types</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">override</span> <span class="k">var</span> <span class="nv">based</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span> <span class="p">:</span> <span class="kt">String</span><span class="p">]</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/c:@M@SourceryRuntime@objc(cs)Enum(py)hasAssociatedValues"></a>
|
||
<a name="//apple_ref/swift/Property/hasAssociatedValues" class="dashAnchor"></a>
|
||
<a class="token" href="#/c:@M@SourceryRuntime@objc(cs)Enum(py)hasAssociatedValues">hasAssociatedValues</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
<p>Whether enum contains any associated values</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">hasAssociatedValues</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/c:@M@SourceryRuntime@objc(cs)Enum(im)diffAgainst:"></a>
|
||
<a name="//apple_ref/swift/Method/diffAgainst(_:)" class="dashAnchor"></a>
|
||
<a class="token" href="#/c:@M@SourceryRuntime@objc(cs)Enum(im)diffAgainst:">diffAgainst(_:<wbr>)</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
|
||
</div>
|
||
<div class="declaration">
|
||
<h4>Declaration</h4>
|
||
<div class="language">
|
||
<p class="aside-title">Swift</p>
|
||
<pre class="highlight swift"><code><span class="k">override</span> <span class="kd">public</span> <span class="kd">func</span> <span class="nf">diffAgainst</span><span class="p">(</span><span class="n">_</span> <span class="nv">object</span><span class="p">:</span> <span class="kt">Any</span><span class="p">?)</span> <span class="o">-></span> <span class="kt"><a href="../Classes/DiffableResult.html">DiffableResult</a></span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</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>
|