mirror of
https://github.com/krzysztofzablocki/Sourcery.git
synced 2026-04-07 19:17:40 +00:00
Ilya Puchka
574 lines
26 KiB
HTML
574 lines
26 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<title>TypeName 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/TypeName" class="dashAnchor"></a>
|
|
<a title="TypeName Class Reference"></a>
|
|
<header>
|
|
<div class="content-wrapper">
|
|
<p><a href="../index.html">Sourcery 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>
|
|
</div>
|
|
</header>
|
|
<div class="content-wrapper">
|
|
<p id="breadcrumbs">
|
|
<a href="../index.html">Sourcery Reference</a>
|
|
<img id="carat" src="../img/carat.png" />
|
|
TypeName 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="../diffable.html">Diffable</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../linuxmain.html">LinuxMain</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/TypesReflectionBox.html">TypesReflectionBox</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/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/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/Attribute.html">Attribute</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="nav-group-name">
|
|
<a href="../Other Protocols.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/Typed.html">Typed</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<article class="main-content">
|
|
<section>
|
|
<section class="section">
|
|
<h1>TypeName</h1>
|
|
<div class="declaration">
|
|
<div class="language">
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">TypeName</span><span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">AutoCoding</span><span class="p">,</span> <span class="kt">AutoEquatable</span><span class="p">,</span> <span class="kt">AutoDiffable</span><span class="p">,</span> <span class="kt">AutoJSExport</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<p>Describes name of the type used in typed declaration (variable, method parameter or return value etc.)</p>
|
|
|
|
</section>
|
|
<section class="section task-group-section">
|
|
<div class="task-group">
|
|
<ul>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:vC8Sourcery8TypeName4nameSS"></a>
|
|
<a name="//apple_ref/swift/Property/name" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:vC8Sourcery8TypeName4nameSS">name</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Type name used in declaration</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">name</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:vC8Sourcery8TypeName14actualTypeNameGSqS0__"></a>
|
|
<a name="//apple_ref/swift/Property/actualTypeName" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:vC8Sourcery8TypeName14actualTypeNameGSqS0__">actualTypeName</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Actual type name if given type name is a typealias</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">internal(set)</span> <span class="k">var</span> <span class="nv">actualTypeName</span><span class="p">:</span> <span class="kt">TypeName</span><span class="p">?</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:vC8Sourcery8TypeName10attributesGVs10DictionarySSCS_9Attribute_"></a>
|
|
<a name="//apple_ref/swift/Property/attributes" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:vC8Sourcery8TypeName10attributesGVs10DictionarySSCS_9Attribute_">attributes</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Type name attributes, i.e. <code>@escaping</code></p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">attributes</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">:</span> <span class="kt"><a href="../Classes/Attribute.html">Attribute</a></span><span class="p">]</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:vC8Sourcery8TypeName10isOptionalSb"></a>
|
|
<a name="//apple_ref/swift/Property/isOptional" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:vC8Sourcery8TypeName10isOptionalSb">isOptional</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Whether type is optional</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">isOptional</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:vC8Sourcery8TypeName29isImplicitlyUnwrappedOptionalSb"></a>
|
|
<a name="//apple_ref/swift/Property/isImplicitlyUnwrappedOptional" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:vC8Sourcery8TypeName29isImplicitlyUnwrappedOptionalSb">isImplicitlyUnwrappedOptional</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Whether type is implicitly unwrapped optional</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">isImplicitlyUnwrappedOptional</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:vC8Sourcery8TypeName17unwrappedTypeNameSS"></a>
|
|
<a name="//apple_ref/swift/Property/unwrappedTypeName" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:vC8Sourcery8TypeName17unwrappedTypeNameSS">unwrappedTypeName</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Type name without attributes and optional type information</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">unwrappedTypeName</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:vC8Sourcery8TypeName6isVoidSb"></a>
|
|
<a name="//apple_ref/swift/Property/isVoid" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:vC8Sourcery8TypeName6isVoidSb">isVoid</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Whether type is void (<code>Void</code> or <code>()</code>)</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isVoid</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:vC8Sourcery8TypeName7isTupleSb"></a>
|
|
<a name="//apple_ref/swift/Property/isTuple" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:vC8Sourcery8TypeName7isTupleSb">isTuple</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Whether type is a tuple</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isTuple</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:vC8Sourcery8TypeName5tupleGSqCS_9TupleType_"></a>
|
|
<a name="//apple_ref/swift/Property/tuple" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:vC8Sourcery8TypeName5tupleGSqCS_9TupleType_">tuple</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Tuple type data</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">tuple</span><span class="p">:</span> <span class="kt"><a href="../Classes/TupleType.html">TupleType</a></span><span class="p">?</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:vC8Sourcery8TypeName7isArraySb"></a>
|
|
<a name="//apple_ref/swift/Property/isArray" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:vC8Sourcery8TypeName7isArraySb">isArray</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Whether type is an array</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isArray</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:vC8Sourcery8TypeName5arrayGSqCS_9ArrayType_"></a>
|
|
<a name="//apple_ref/swift/Property/array" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:vC8Sourcery8TypeName5arrayGSqCS_9ArrayType_">array</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Array type data</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">array</span><span class="p">:</span> <span class="kt"><a href="../Classes/ArrayType.html">ArrayType</a></span><span class="p">?</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:vC8Sourcery8TypeName12isDictionarySb"></a>
|
|
<a name="//apple_ref/swift/Property/isDictionary" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:vC8Sourcery8TypeName12isDictionarySb">isDictionary</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Whether type is a dictionary</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isDictionary</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:vC8Sourcery8TypeName10dictionaryGSqCS_14DictionaryType_"></a>
|
|
<a name="//apple_ref/swift/Property/dictionary" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:vC8Sourcery8TypeName10dictionaryGSqCS_14DictionaryType_">dictionary</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Dictionary type data</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">internal(set)</span> <span class="k">var</span> <span class="nv">dictionary</span><span class="p">:</span> <span class="kt"><a href="../Classes/DictionaryType.html">DictionaryType</a></span><span class="p">?</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:vC8Sourcery8TypeName9isClosureSb"></a>
|
|
<a name="//apple_ref/swift/Property/isClosure" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:vC8Sourcery8TypeName9isClosureSb">isClosure</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Whether type is a closure</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isClosure</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:vC8Sourcery8TypeName11descriptionSS"></a>
|
|
<a name="//apple_ref/swift/Property/description" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:vC8Sourcery8TypeName11descriptionSS">description</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Returns value of <code><a href="../Classes/TypeName.html#/s:vC8Sourcery8TypeName4nameSS">name</a></code> property.</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="k">override</span> <span class="k">var</span> <span class="nv">description</span><span class="p">:</span> <span class="kt">String</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section id="footer">
|
|
<p>Copyright © 2016 Pixle. All rights reserved.</p>
|
|
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.5</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
|
</section>
|
|
</article>
|
|
</div>
|
|
</body>
|
|
</div>
|
|
</html>
|