Files
Sourcery/docs/Classes/TypesReflectionBox.html
T
2017-04-11 20:31:58 +02:00

388 lines
18 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<title>TypesReflectionBox 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/TypesReflectionBox" class="dashAnchor"></a>
<a title="TypesReflectionBox 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" />
TypesReflectionBox 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>TypesReflectionBox</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">TypesReflectionBox</span><span class="p">:</span> <span class="kt">NSObject</span></code></pre>
</div>
</div>
<p>Provides access to parsed types in templates</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:vC8Sourcery18TypesReflectionBox7classesGSaCS_5Class_"></a>
<a name="//apple_ref/swift/Property/classes" class="dashAnchor"></a>
<a class="token" href="#/s:vC8Sourcery18TypesReflectionBox7classesGSaCS_5Class_">classes</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>All known classes</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">lazy</span> <span class="k">var</span> <span class="nv">classes</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/Class.html">Class</a></span><span class="p">]</span> <span class="o">=</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vC8Sourcery18TypesReflectionBox3allGSaCS_4Type_"></a>
<a name="//apple_ref/swift/Property/all" class="dashAnchor"></a>
<a class="token" href="#/s:vC8Sourcery18TypesReflectionBox3allGSaCS_4Type_">all</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>All known types, excluding protocols</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">lazy</span> <span class="k">var</span> <span class="nv">all</span><span class="p">:</span> <span class="p">[</span><span class="k">Type</span><span class="p">]</span> <span class="o">=</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vC8Sourcery18TypesReflectionBox9protocolsGSaCS_8Protocol_"></a>
<a name="//apple_ref/swift/Property/protocols" class="dashAnchor"></a>
<a class="token" href="#/s:vC8Sourcery18TypesReflectionBox9protocolsGSaCS_8Protocol_">protocols</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>All known protocols</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">lazy</span> <span class="k">var</span> <span class="nv">protocols</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/Protocol.html">Protocol</a></span><span class="p">]</span> <span class="o">=</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vC8Sourcery18TypesReflectionBox7structsGSaCS_6Struct_"></a>
<a name="//apple_ref/swift/Property/structs" class="dashAnchor"></a>
<a class="token" href="#/s:vC8Sourcery18TypesReflectionBox7structsGSaCS_6Struct_">structs</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>All known structs</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">lazy</span> <span class="k">var</span> <span class="nv">structs</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/Struct.html">Struct</a></span><span class="p">]</span> <span class="o">=</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vC8Sourcery18TypesReflectionBox5enumsGSaCS_4Enum_"></a>
<a name="//apple_ref/swift/Property/enums" class="dashAnchor"></a>
<a class="token" href="#/s:vC8Sourcery18TypesReflectionBox5enumsGSaCS_4Enum_">enums</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>All known enums</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">lazy</span> <span class="k">var</span> <span class="nv">enums</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/Enum.html">Enum</a></span><span class="p">]</span> <span class="o">=</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vC8Sourcery18TypesReflectionBox5basedGVs10DictionarySSGSaCS_4Type__"></a>
<a name="//apple_ref/swift/Property/based" class="dashAnchor"></a>
<a class="token" href="#/s:vC8Sourcery18TypesReflectionBox5basedGVs10DictionarySSGSaCS_4Type__">based</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Types based on any other type, grouped by its name, even if they are not known.
<code>types.based.MyType</code> returns list of types based on <code>MyType</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="kd">lazy</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="p">[</span><span class="k">Type</span><span class="p">]]</span> <span class="o">=</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vC8Sourcery18TypesReflectionBox10inheritingGVs10DictionarySSGSaCS_4Type__"></a>
<a name="//apple_ref/swift/Property/inheriting" class="dashAnchor"></a>
<a class="token" href="#/s:vC8Sourcery18TypesReflectionBox10inheritingGVs10DictionarySSGSaCS_4Type__">inheriting</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Classes inheriting from any known class, grouped by its name.
<code>types.inheriting.MyClass</code> returns list of types inheriting from <code>MyClass</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="kd">lazy</span> <span class="k">var</span> <span class="nv">inheriting</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">:</span> <span class="p">[</span><span class="k">Type</span><span class="p">]]</span> <span class="o">=</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vC8Sourcery18TypesReflectionBox12implementingGVs10DictionarySSGSaCS_4Type__"></a>
<a name="//apple_ref/swift/Property/implementing" class="dashAnchor"></a>
<a class="token" href="#/s:vC8Sourcery18TypesReflectionBox12implementingGVs10DictionarySSGSaCS_4Type__">implementing</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Types implementing known protocol, grouped by its name.
<code>types.implementing.MyProtocol</code> returns list of types implementing <code>MyProtocol</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="kd">lazy</span> <span class="k">var</span> <span class="nv">implementing</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">:</span> <span class="p">[</span><span class="k">Type</span><span class="p">]]</span> <span class="o">=</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>