Files
SwiftLint/unused_declaration.html
2025-06-22 14:27:57 +00:00

677 lines
46 KiB
HTML
Raw Permalink 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>unused_declaration 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="unused_declaration Reference"></a>
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="index.html">
SwiftLintCore 0.59.1 Docs
</a>
(100% documented)
</p>
<div class="header-col--secondary">
<form role="search" action="search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</div>
<p class="header-col header-col--secondary">
<a class="header-link" href="https://github.com/realm/SwiftLint">
<img class="header-icon" src="img/gh.png" alt="GitHub"/>
View on GitHub
</a>
</p>
<p class="header-col header-col--secondary">
<a class="header-link" href="dash-feed://https%3A%2F%2Frealm.github.io%2FSwiftLint%2Fdocsets%2FSwiftLintCore.xml">
<img class="header-icon" src="img/dash.png" alt="Dash"/>
Install in Dash
</a>
</p>
</header>
<p class="breadcrumbs">
<a class="breadcrumb" href="index.html">SwiftLintCore</a>
<img class="carat" src="img/carat.png" alt=""/>
<a class="breadcrumb" href="Guides.html">Guides</a>
<img class="carat" src="img/carat.png" alt=""/>
unused_declaration Reference
</p>
<div class="content-wrapper">
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="Rules.html">Rules</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="rule-directory.html">Rule Directory</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/BodyLengthVisitor.html">BodyLengthVisitor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/CodeBlockVisitor.html">CodeBlockVisitor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/CodeIndentingRewriter.html">CodeIndentingRewriter</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/CodeIndentingRewriter/IndentationStyle.html"> IndentationStyle</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/DeclaredIdentifiersTrackingVisitor.html">DeclaredIdentifiersTrackingVisitor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/RuleRegistry.html">RuleRegistry</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/RuleStorage.html">RuleStorage</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/SwiftLintFile.html">SwiftLintFile</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/ViolationsSyntaxRewriter.html">ViolationsSyntaxRewriter</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Classes/ViolationsSyntaxVisitor.html">ViolationsSyntaxVisitor</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Enums/AccessControlLevel.html">AccessControlLevel</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Enums/CurrentRule.html">CurrentRule</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Enums/IdentifierDeclaration.html">IdentifierDeclaration</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Enums/Issue.html">Issue</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Enums/OptionType.html">OptionType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Enums/RuleIdentifier.html">RuleIdentifier</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Enums/RuleKind.html">RuleKind</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Enums/RuleListError.html">RuleListError</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Enums/SwiftExpressionKind.html">SwiftExpressionKind</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Enums/SwiftSyntaxKindBridge.html">SwiftSyntaxKindBridge</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Enums/ViolationSeverity.html">ViolationSeverity</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions/Array.html">Array</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions/Bool.html">Bool</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions/Double.html">Double</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions/Int.html">Int</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions/Optional.html">Optional</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions/Set.html">Set</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Extensions/String.html">String</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/ASTRule.html">ASTRule</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/AcceptableByConfigurationElement.html">AcceptableByConfigurationElement</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/AnalyzerRule.html">AnalyzerRule</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols.html#/s:13SwiftLintCore17AnyCollectingRuleP">AnyCollectingRule</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/CacheDescriptionProvider.html">CacheDescriptionProvider</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/CollectingRule.html">CollectingRule</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/ConditionallySourceKitFree.html">ConditionallySourceKitFree</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/CorrectableRule.html">CorrectableRule</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/Documentable.html">Documentable</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols.html#/s:13SwiftLintCore19InlinableOptionTypeP">InlinableOptionType</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols.html#/s:13SwiftLintCore9OptInRuleP">OptInRule</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/Rule.html">Rule</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/RuleConfiguration.html">RuleConfiguration</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/SeverityBasedRuleConfiguration.html">SeverityBasedRuleConfiguration</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols.html#/s:13SwiftLintCore17SourceKitFreeRuleP">SourceKitFreeRule</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/SubstitutionCorrectableRule.html">SubstitutionCorrectableRule</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/SwiftSyntaxCorrectableRule.html">SwiftSyntaxCorrectableRule</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/SwiftSyntaxRule.html">SwiftSyntaxRule</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Protocols/VersionComparable.html">VersionComparable</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/Baseline.html">Baseline</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/ChildOptionSeverityConfiguration.html">ChildOptionSeverityConfiguration</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/Command.html">Command</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/Command/Action.html"> Action</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/Command/Modifier.html"> Modifier</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/ConfigurationElement.html">ConfigurationElement</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/ConfigurationElement/DeprecationNotice.html"> DeprecationNotice</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/Correction.html">Correction</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/Example.html">Example</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/Location.html">Location</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/ReasonedRuleViolation.html">ReasonedRuleViolation</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/ReasonedRuleViolation/ViolationCorrection.html"> ViolationCorrection</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/RegexConfiguration.html">RegexConfiguration</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/RegexConfiguration/ExecutionMode.html"> ExecutionMode</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/Region.html">Region</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/RuleConfigurationDescription.html">RuleConfigurationDescription</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs.html#/s:13SwiftLintCore35RuleConfigurationDescriptionBuilderV">RuleConfigurationDescriptionBuilder</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/RuleConfigurationOption.html">RuleConfigurationOption</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/RuleDescription.html">RuleDescription</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/RuleList.html">RuleList</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/RuleParameter.html">RuleParameter</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/SeverityConfiguration.html">SeverityConfiguration</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/SeverityLevelsConfiguration.html">SeverityLevelsConfiguration</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/Stack.html">Stack</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/StyleViolation.html">StyleViolation</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/SwiftLintSyntaxMap.html">SwiftLintSyntaxMap</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/SwiftLintSyntaxToken.html">SwiftLintSyntaxToken</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Structs/SwiftVersion.html">SwiftVersion</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="Macros.html">Macros</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="Macros.html#/s:13SwiftLintCore32AcceptableByConfigurationElementyycfm">AcceptableByConfigurationElement()</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Macros.html#/s:13SwiftLintCore16AutoConfigParseryycfm">AutoConfigParser()</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="Macros.html#/s:13SwiftLintCore0A10SyntaxRule15foldExpressions16explicitRewriter11correctable5optInySb_S3btcfm">SwiftSyntaxRule(foldExpressions:explicitRewriter:correctable:optIn:)</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section class="section">
<div class="section-content top-matter">
<h1 id='unused-declaration' class='heading'>Unused Declaration</h1>
<p>Declarations should be referenced at least once within all files linted</p>
<ul>
<li><strong>Identifier:</strong> <code>unused_declaration</code></li>
<li><strong>Enabled by default:</strong> No</li>
<li><strong>Supports autocorrection:</strong> No</li>
<li><strong>Kind:</strong> lint</li>
<li><strong>Analyzer rule:</strong> Yes</li>
<li><strong>Minimum Swift compiler version:</strong> 5.0.0</li>
<li><strong>Default configuration:</strong>
<table>
<thead>
<tr><th>Key</th><th>Value</th></tr>
</thead>
<tbody>
<tr>
<td>
severity
</td>
<td>
error
</td>
</tr>
<tr>
<td>
include_public_and_open
</td>
<td>
false
</td>
</tr>
<tr>
<td>
related_usrs_to_skip
</td>
<td>
[&ldquo;s:7SwiftUI15PreviewProviderP&rdquo;]
</td>
</tr>
</tbody>
</table></li>
</ul>
<h2 id='non-triggering-examples' class='heading'>Non Triggering Examples</h2>
<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">kConstant</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">_</span> <span class="o">=</span> <span class="n">kConstant</span>
</code></pre>
<pre class="highlight swift"><code><span class="kd">enum</span> <span class="kt">Change</span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;</span> <span class="p">{</span>
<span class="k">case</span> <span class="nf">insert</span><span class="p">(</span><span class="kt">T</span><span class="p">)</span>
<span class="k">case</span> <span class="nf">delete</span><span class="p">(</span><span class="kt">T</span><span class="p">)</span>
<span class="p">}</span>
<span class="kd">extension</span> <span class="kt">Sequence</span> <span class="p">{</span>
<span class="kd">func</span> <span class="n">deletes</span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="p">[</span><span class="kt">T</span><span class="p">]</span> <span class="k">where</span> <span class="kt">Element</span> <span class="o">==</span> <span class="kt">Change</span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;</span> <span class="p">{</span>
<span class="k">return</span> <span class="n">compactMap</span> <span class="p">{</span> <span class="n">operation</span> <span class="k">in</span>
<span class="k">if</span> <span class="k">case</span> <span class="o">.</span><span class="nf">delete</span><span class="p">(</span><span class="k">let</span> <span class="nv">value</span><span class="p">)</span> <span class="o">=</span> <span class="n">operation</span> <span class="p">{</span>
<span class="k">return</span> <span class="n">value</span>
<span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
<span class="k">return</span> <span class="kc">nil</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="k">let</span> <span class="nv">changes</span> <span class="o">=</span> <span class="p">[</span><span class="kt">Change</span><span class="o">.</span><span class="nf">insert</span><span class="p">(</span><span class="mi">0</span><span class="p">),</span> <span class="o">.</span><span class="nf">delete</span><span class="p">(</span><span class="mi">0</span><span class="p">)]</span>
<span class="n">_</span> <span class="o">=</span> <span class="n">changes</span><span class="o">.</span><span class="nf">deletes</span><span class="p">()</span>
</code></pre>
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">Item</span><span class="p">:</span> <span class="kt">Codable</span> <span class="p">{}</span>
<span class="kd">struct</span> <span class="kt">ResponseModel</span><span class="p">:</span> <span class="kt">Codable</span> <span class="p">{</span>
<span class="k">let</span> <span class="nv">items</span><span class="p">:</span> <span class="p">[</span><span class="kt">Item</span><span class="p">]</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">items</span> <span class="o">=</span> <span class="s">"ResponseItems"</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="n">_</span> <span class="o">=</span> <span class="kt">ResponseModel</span><span class="p">(</span><span class="nv">items</span><span class="p">:</span> <span class="p">[</span><span class="kt">Item</span><span class="p">()])</span><span class="o">.</span><span class="n">items</span>
</code></pre>
<pre class="highlight swift"><code><span class="kd">class</span> <span class="kt">ResponseModel</span> <span class="p">{</span>
<span class="kd">@objc</span> <span class="kd">func</span> <span class="nf">foo</span><span class="p">()</span> <span class="p">{</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="n">_</span> <span class="o">=</span> <span class="kt">ResponseModel</span><span class="p">()</span>
</code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">foo</span><span class="p">()</span> <span class="p">{}</span>
</code></pre>
<pre class="highlight swift"><code><span class="kd">protocol</span> <span class="kt">Foo</span> <span class="p">{}</span>
<span class="kd">extension</span> <span class="kt">Foo</span> <span class="p">{</span>
<span class="kd">func</span> <span class="nf">bar</span><span class="p">()</span> <span class="p">{}</span>
<span class="p">}</span>
<span class="kd">struct</span> <span class="kt">MyStruct</span><span class="p">:</span> <span class="kt">Foo</span> <span class="p">{}</span>
<span class="kt">MyStruct</span><span class="p">()</span><span class="o">.</span><span class="nf">bar</span><span class="p">()</span>
</code></pre>
<pre class="highlight swift"><code><span class="kd">import</span> <span class="kt">XCTest</span>
<span class="kd">class</span> <span class="kt">MyTests</span><span class="p">:</span> <span class="kt">XCTestCase</span> <span class="p">{</span>
<span class="kd">func</span> <span class="nf">testExample</span><span class="p">()</span> <span class="p">{}</span>
<span class="p">}</span>
</code></pre>
<pre class="highlight swift"><code><span class="kd">import</span> <span class="kt">XCTest</span>
<span class="kd">open</span> <span class="kd">class</span> <span class="kt">BestTestCase</span><span class="p">:</span> <span class="kt">XCTestCase</span> <span class="p">{}</span>
<span class="kd">class</span> <span class="kt">MyTests</span><span class="p">:</span> <span class="kt">BestTestCase</span> <span class="p">{</span>
<span class="kd">func</span> <span class="nf">testExample</span><span class="p">()</span> <span class="p">{}</span>
<span class="p">}</span>
</code></pre>
<pre class="highlight swift"><code> <span class="kd">struct</span> <span class="kt">S</span> <span class="p">{</span>
<span class="k">var</span> <span class="nv">i</span><span class="p">:</span> <span class="kt">Int</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span>
<span class="kd">func</span> <span class="nf">f</span><span class="p">()</span> <span class="p">{</span>
<span class="k">if</span> <span class="k">let</span> <span class="nv">i</span> <span class="p">{</span> <span class="nf">print</span><span class="p">(</span><span class="n">i</span><span class="p">)</span> <span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="kt">S</span><span class="p">()</span><span class="o">.</span><span class="nf">f</span><span class="p">()</span>
</code></pre>
<pre class="highlight swift"><code><span class="kd">enum</span> <span class="kt">Component</span> <span class="p">{</span>
<span class="k">case</span> <span class="nf">string</span><span class="p">(</span><span class="kt">StaticString</span><span class="p">)</span>
<span class="kd">indirect</span> <span class="k">case</span> <span class="nf">array</span><span class="p">([</span><span class="kt">Component</span><span class="p">])</span>
<span class="kd">indirect</span> <span class="k">case</span> <span class="nf">optional</span><span class="p">(</span><span class="kt">Component</span><span class="p">?)</span>
<span class="p">}</span>
<span class="kd">@resultBuilder</span>
<span class="kd">struct</span> <span class="kt">ComponentBuilder</span> <span class="p">{</span>
<span class="kd">static</span> <span class="kd">func</span> <span class="nf">buildBlock</span><span class="p">(</span><span class="n">_</span> <span class="nv">components</span><span class="p">:</span> <span class="kt">Component</span><span class="o">...</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Component</span> <span class="p">{</span>
<span class="k">return</span> <span class="o">.</span><span class="nf">array</span><span class="p">(</span><span class="n">components</span><span class="p">)</span>
<span class="p">}</span>
<span class="kd">static</span> <span class="kd">func</span> <span class="nf">buildExpression</span><span class="p">(</span><span class="n">_</span> <span class="nv">string</span><span class="p">:</span> <span class="kt">StaticString</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Component</span> <span class="p">{</span>
<span class="k">return</span> <span class="o">.</span><span class="nf">string</span><span class="p">(</span><span class="n">string</span><span class="p">)</span>
<span class="p">}</span>
<span class="kd">static</span> <span class="kd">func</span> <span class="nf">buildOptional</span><span class="p">(</span><span class="n">_</span> <span class="nv">component</span><span class="p">:</span> <span class="kt">Component</span><span class="p">?)</span> <span class="o">-&gt;</span> <span class="kt">Component</span> <span class="p">{</span>
<span class="k">return</span> <span class="o">.</span><span class="nf">optional</span><span class="p">(</span><span class="n">component</span><span class="p">)</span>
<span class="p">}</span>
<span class="kd">static</span> <span class="kd">func</span> <span class="nf">buildEither</span><span class="p">(</span><span class="n">first</span> <span class="nv">component</span><span class="p">:</span> <span class="kt">Component</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Component</span> <span class="p">{</span>
<span class="k">return</span> <span class="n">component</span>
<span class="p">}</span>
<span class="kd">static</span> <span class="kd">func</span> <span class="nf">buildEither</span><span class="p">(</span><span class="n">second</span> <span class="nv">component</span><span class="p">:</span> <span class="kt">Component</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Component</span> <span class="p">{</span>
<span class="k">return</span> <span class="n">component</span>
<span class="p">}</span>
<span class="kd">static</span> <span class="kd">func</span> <span class="nf">buildArray</span><span class="p">(</span><span class="n">_</span> <span class="nv">components</span><span class="p">:</span> <span class="p">[</span><span class="kt">Component</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="kt">Component</span> <span class="p">{</span>
<span class="k">return</span> <span class="o">.</span><span class="nf">array</span><span class="p">(</span><span class="n">components</span><span class="p">)</span>
<span class="p">}</span>
<span class="kd">static</span> <span class="kd">func</span> <span class="nf">buildLimitedAvailability</span><span class="p">(</span><span class="n">_</span> <span class="nv">component</span><span class="p">:</span> <span class="kt">Component</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Component</span> <span class="p">{</span>
<span class="k">return</span> <span class="n">component</span>
<span class="p">}</span>
<span class="kd">static</span> <span class="kd">func</span> <span class="nf">buildFinalResult</span><span class="p">(</span><span class="n">_</span> <span class="nv">component</span><span class="p">:</span> <span class="kt">Component</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Component</span> <span class="p">{</span>
<span class="k">return</span> <span class="n">component</span>
<span class="p">}</span>
<span class="kd">static</span> <span class="kd">func</span> <span class="nf">buildPartialBlock</span><span class="p">(</span><span class="n">first</span> <span class="nv">component</span><span class="p">:</span> <span class="kt">Component</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Component</span> <span class="p">{</span>
<span class="k">return</span> <span class="n">component</span>
<span class="p">}</span>
<span class="kd">static</span> <span class="kd">func</span> <span class="nf">buildPartialBlock</span><span class="p">(</span><span class="n">accumulated</span> <span class="nv">component</span><span class="p">:</span> <span class="kt">Component</span><span class="p">,</span> <span class="nv">next</span><span class="p">:</span> <span class="kt">Component</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Component</span> <span class="p">{</span>
<span class="k">return</span> <span class="n">component</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="kd">func</span> <span class="nf">acceptComponentBuilder</span><span class="p">(</span><span class="kd">@ComponentBuilder</span> <span class="n">_</span> <span class="nv">body</span><span class="p">:</span> <span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">Component</span><span class="p">)</span> <span class="p">{</span>
<span class="nf">print</span><span class="p">(</span><span class="nf">body</span><span class="p">())</span>
<span class="p">}</span>
<span class="n">acceptComponentBuilder</span> <span class="p">{</span>
<span class="s">"hello"</span>
<span class="p">}</span>
</code></pre>
<pre class="highlight swift"><code><span class="kd">import</span> <span class="kt">Cocoa</span>
<span class="kd">@NSApplicationMain</span>
<span class="kd">final</span> <span class="kd">class</span> <span class="kt">AppDelegate</span><span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSApplicationDelegate</span> <span class="p">{</span>
<span class="kd">func</span> <span class="nf">applicationWillFinishLaunching</span><span class="p">(</span><span class="n">_</span> <span class="nv">notification</span><span class="p">:</span> <span class="kt">Notification</span><span class="p">)</span> <span class="p">{}</span>
<span class="kd">func</span> <span class="nf">applicationWillBecomeActive</span><span class="p">(</span><span class="n">_</span> <span class="nv">notification</span><span class="p">:</span> <span class="kt">Notification</span><span class="p">)</span> <span class="p">{}</span>
<span class="p">}</span>
</code></pre>
<pre class="highlight swift"><code><span class="kd">import</span> <span class="kt">Foundation</span>
<span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">Foo</span><span class="p">:</span> <span class="kt">NSObject</span> <span class="p">{</span>
<span class="kd">@IBAction</span> <span class="kd">private</span> <span class="kd">func</span> <span class="nf">foo</span><span class="p">()</span> <span class="p">{}</span>
<span class="p">}</span>
</code></pre>
<pre class="highlight swift"><code><span class="kd">import</span> <span class="kt">Foundation</span>
<span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">Foo</span><span class="p">:</span> <span class="kt">NSObject</span> <span class="p">{</span>
<span class="kd">@objc</span> <span class="kd">func</span> <span class="nf">foo</span><span class="p">()</span> <span class="p">{}</span>
<span class="p">}</span>
</code></pre>
<pre class="highlight swift"><code><span class="kd">import</span> <span class="kt">Foundation</span>
<span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">Foo</span><span class="p">:</span> <span class="kt">NSObject</span> <span class="p">{</span>
<span class="kd">@IBInspectable</span> <span class="kd">private</span> <span class="k">var</span> <span class="nv">innerPaddingWidth</span><span class="p">:</span> <span class="kt">Int</span> <span class="p">{</span>
<span class="k">set</span> <span class="p">{</span> <span class="k">self</span><span class="o">.</span><span class="n">backgroundView</span><span class="o">.</span><span class="n">innerPaddingWidth</span> <span class="o">=</span> <span class="n">newValue</span> <span class="p">}</span>
<span class="k">get</span> <span class="p">{</span> <span class="k">return</span> <span class="k">self</span><span class="o">.</span><span class="n">backgroundView</span><span class="o">.</span><span class="n">innerPaddingWidth</span> <span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
</code></pre>
<pre class="highlight swift"><code><span class="kd">import</span> <span class="kt">Foundation</span>
<span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">Foo</span><span class="p">:</span> <span class="kt">NSObject</span> <span class="p">{</span>
<span class="kd">@IBOutlet</span> <span class="kd">private</span> <span class="k">var</span> <span class="nv">bar</span><span class="p">:</span> <span class="kt">NSObject</span><span class="o">!</span> <span class="p">{</span>
<span class="k">set</span> <span class="p">{</span> <span class="nf">fatalError</span><span class="p">()</span> <span class="p">}</span>
<span class="k">get</span> <span class="p">{</span> <span class="nf">fatalError</span><span class="p">()</span> <span class="p">}</span>
<span class="p">}</span>
<span class="kd">@IBOutlet</span> <span class="kd">private</span> <span class="k">var</span> <span class="nv">baz</span><span class="p">:</span> <span class="kt">NSObject</span><span class="o">!</span> <span class="p">{</span>
<span class="k">willSet</span> <span class="p">{</span> <span class="nf">print</span><span class="p">(</span><span class="s">"willSet"</span><span class="p">)</span> <span class="p">}</span>
<span class="p">}</span>
<span class="kd">@IBOutlet</span> <span class="kd">private</span> <span class="k">var</span> <span class="nv">buzz</span><span class="p">:</span> <span class="kt">NSObject</span><span class="o">!</span> <span class="p">{</span>
<span class="k">didSet</span> <span class="p">{</span> <span class="nf">print</span><span class="p">(</span><span class="s">"didSet"</span><span class="p">)</span> <span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
</code></pre>
<h2 id='triggering-examples' class='heading'>Triggering Examples</h2>
<pre class="highlight swift"><code><span class="kd">let</span> <span class="err"></span><span class="n">kConstant</span> <span class="o">=</span> <span class="mi">0</span>
</code></pre>
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">Item</span> <span class="p">{}</span>
<span class="kd">struct</span> <span class="err"></span><span class="kt">ResponseModel</span><span class="p">:</span> <span class="kt">Codable</span> <span class="p">{</span>
<span class="kd">let</span> <span class="err"></span><span class="nv">items</span><span class="p">:</span> <span class="p">[</span><span class="kt">Item</span><span class="p">]</span>
<span class="kd">enum</span> <span class="err"></span><span class="kt">CodingKeys</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span>
<span class="k">case</span> <span class="n">items</span> <span class="o">=</span> <span class="s">"ResponseItems"</span>
<span class="p">}</span>
<span class="p">}</span>
</code></pre>
<pre class="highlight swift"><code><span class="kd">class</span> <span class="err"></span><span class="kt">ResponseModel</span> <span class="p">{</span>
<span class="kd">func</span> <span class="err"></span><span class="nf">foo</span><span class="p">()</span> <span class="p">{</span>
<span class="p">}</span>
<span class="p">}</span>
</code></pre>
<pre class="highlight swift"><code><span class="c1">//</span>
<span class="c1">// include_public_and_open: true</span>
<span class="c1">//</span>
<span class="kd">public</span> <span class="kd">func</span> <span class="err"></span><span class="nf">foo</span><span class="p">()</span> <span class="p">{}</span>
</code></pre>
<pre class="highlight swift"><code><span class="kd">protocol</span> <span class="kt">Foo</span> <span class="p">{</span>
<span class="kd">func</span> <span class="err"></span><span class="nf">bar1</span><span class="p">()</span>
<span class="p">}</span>
<span class="kd">extension</span> <span class="kt">Foo</span> <span class="p">{</span>
<span class="kd">func</span> <span class="nf">bar1</span><span class="p">()</span> <span class="p">{}</span>
<span class="kd">func</span> <span class="err"></span><span class="nf">bar2</span><span class="p">()</span> <span class="p">{}</span>
<span class="p">}</span>
<span class="kd">struct</span> <span class="kt">MyStruct</span><span class="p">:</span> <span class="kt">Foo</span> <span class="p">{}</span>
<span class="n">_</span> <span class="o">=</span> <span class="kt">MyStruct</span><span class="p">()</span>
</code></pre>
<pre class="highlight swift"><code><span class="kd">import</span> <span class="kt">XCTest</span>
<span class="kd">class</span> <span class="err"></span><span class="kt">MyTests</span><span class="p">:</span> <span class="kt">NSObject</span> <span class="p">{</span>
<span class="kd">func</span> <span class="err"></span><span class="nf">testExample</span><span class="p">()</span> <span class="p">{}</span>
<span class="p">}</span>
</code></pre>
<pre class="highlight swift"><code><span class="kd">enum</span> <span class="kt">Component</span> <span class="p">{</span>
<span class="k">case</span> <span class="nf">string</span><span class="p">(</span><span class="kt">StaticString</span><span class="p">)</span>
<span class="kd">indirect</span> <span class="k">case</span> <span class="nf">array</span><span class="p">([</span><span class="kt">Component</span><span class="p">])</span>
<span class="kd">indirect</span> <span class="k">case</span> <span class="nf">optional</span><span class="p">(</span><span class="kt">Component</span><span class="p">?)</span>
<span class="p">}</span>
<span class="kd">struct</span> <span class="kt">ComponentBuilder</span> <span class="p">{</span>
<span class="kd">func</span> <span class="err"></span><span class="nf">buildExpression</span><span class="p">(</span><span class="n">_</span> <span class="nv">string</span><span class="p">:</span> <span class="kt">StaticString</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Component</span> <span class="p">{</span>
<span class="k">return</span> <span class="o">.</span><span class="nf">string</span><span class="p">(</span><span class="n">string</span><span class="p">)</span>
<span class="p">}</span>
<span class="kd">func</span> <span class="err"></span><span class="nf">buildBlock</span><span class="p">(</span><span class="n">_</span> <span class="nv">components</span><span class="p">:</span> <span class="kt">Component</span><span class="o">...</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Component</span> <span class="p">{</span>
<span class="k">return</span> <span class="o">.</span><span class="nf">array</span><span class="p">(</span><span class="n">components</span><span class="p">)</span>
<span class="p">}</span>
<span class="kd">func</span> <span class="err"></span><span class="nf">buildIf</span><span class="p">(</span><span class="n">_</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">Component</span><span class="p">?)</span> <span class="o">-&gt;</span> <span class="kt">Component</span> <span class="p">{</span>
<span class="k">return</span> <span class="o">.</span><span class="nf">optional</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
<span class="p">}</span>
<span class="kd">static</span> <span class="kd">func</span> <span class="err"></span><span class="nf">buildABear</span><span class="p">(</span><span class="n">_</span> <span class="nv">components</span><span class="p">:</span> <span class="kt">Component</span><span class="o">...</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Component</span> <span class="p">{</span>
<span class="k">return</span> <span class="o">.</span><span class="nf">array</span><span class="p">(</span><span class="n">components</span><span class="p">)</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="n">_</span> <span class="o">=</span> <span class="kt">ComponentBuilder</span><span class="p">()</span>
</code></pre>
<pre class="highlight swift"><code><span class="kd">protocol</span> <span class="err"></span><span class="kt">Foo</span> <span class="p">{}</span>
<span class="kd">extension</span> <span class="kt">Foo</span> <span class="p">{}</span>
</code></pre>
<pre class="highlight swift"><code><span class="kd">class</span> <span class="err"></span><span class="kt">C</span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;</span> <span class="p">{}</span>
<span class="kd">extension</span> <span class="kt">C</span><span class="o">&lt;</span><span class="kt">Int</span><span class="o">&gt;</span> <span class="p">{}</span>
</code></pre>
<pre class="highlight swift"><code><span class="kd">import</span> <span class="kt">Cocoa</span>
<span class="kd">@NSApplicationMain</span>
<span class="kd">final</span> <span class="kd">class</span> <span class="kt">AppDelegate</span><span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSApplicationDelegate</span> <span class="p">{</span>
<span class="kd">func</span> <span class="err"></span><span class="nf">appWillFinishLaunching</span><span class="p">(</span><span class="n">_</span> <span class="nv">notification</span><span class="p">:</span> <span class="kt">Notification</span><span class="p">)</span> <span class="p">{}</span>
<span class="kd">func</span> <span class="nf">applicationWillBecomeActive</span><span class="p">(</span><span class="n">_</span> <span class="nv">notification</span><span class="p">:</span> <span class="kt">Notification</span><span class="p">)</span> <span class="p">{}</span>
<span class="p">}</span>
</code></pre>
<pre class="highlight swift"><code><span class="kd">import</span> <span class="kt">Cocoa</span>
<span class="kd">final</span> <span class="kd">class</span> <span class="err"></span><span class="kt">AppDelegate</span><span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSApplicationDelegate</span> <span class="p">{</span>
<span class="kd">func</span> <span class="nf">applicationWillFinishLaunching</span><span class="p">(</span><span class="n">_</span> <span class="nv">notification</span><span class="p">:</span> <span class="kt">Notification</span><span class="p">)</span> <span class="p">{}</span>
<span class="kd">func</span> <span class="nf">applicationWillBecomeActive</span><span class="p">(</span><span class="n">_</span> <span class="nv">notification</span><span class="p">:</span> <span class="kt">Notification</span><span class="p">)</span> <span class="p">{}</span>
<span class="p">}</span>
</code></pre>
<pre class="highlight swift"><code><span class="kd">import</span> <span class="kt">Foundation</span>
<span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">Foo</span><span class="p">:</span> <span class="kt">NSObject</span> <span class="p">{</span>
<span class="kd">@IBOutlet</span> <span class="kd">var</span> <span class="err"></span><span class="nv">bar</span><span class="p">:</span> <span class="kt">NSObject</span><span class="o">!</span>
<span class="p">}</span>
</code></pre>
<pre class="highlight swift"><code><span class="kd">import</span> <span class="kt">Foundation</span>
<span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">Foo</span><span class="p">:</span> <span class="kt">NSObject</span> <span class="p">{</span>
<span class="kd">@IBInspectable</span> <span class="kd">var</span> <span class="err"></span><span class="nv">bar</span><span class="p">:</span> <span class="kt">String</span><span class="o">!</span>
<span class="p">}</span>
</code></pre>
<pre class="highlight swift"><code><span class="kd">import</span> <span class="kt">Foundation</span>
<span class="kd">final</span> <span class="kd">class</span> <span class="kt">Foo</span><span class="p">:</span> <span class="kt">NSObject</span> <span class="p">{}</span>
<span class="kd">final</span> <span class="kd">class</span> <span class="err"></span><span class="kt">Bar</span> <span class="p">{</span>
<span class="kd">var</span> <span class="err"></span><span class="n">foo</span> <span class="o">=</span> <span class="kt">Foo</span><span class="p">()</span>
<span class="p">}</span>
</code></pre>
</div>
</section>
</article>
</div>
<section class="footer">
<p>© 2023 <a class="link" href="https://jpsim.com" target="_blank" rel="external noopener">JP Simard</a> under MIT.</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</body>
</html>