<!DOCTYPE html> <html lang="en"> <head> <title>Method 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/Method" class="dashAnchor"></a> <a title="Method Class Reference"></a> <header> <div class="content-wrapper"> <p><a href="../index.html">Sourcery 2.2.6 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" /> Method 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>Method</h1> <div class="declaration"> <div class="language"> <pre class="highlight swift"><code><span class="kd">@objc</span><span class="p">(</span><span class="kt">SwiftMethod</span><span class="p">)</span> <span class="kd">@objcMembers</span> <span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">Method</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">SourceryModel</span><span class="p">,</span> <span class="kt"><a href="../Protocols/Annotated.html">Annotated</a></span><span class="p">,</span> <span class="kt"><a href="../Protocols/Documented.html">Documented</a></span><span class="p">,</span> <span class="kt"><a href="../Protocols/Definition.html">Definition</a></span><span class="p">,</span> <span class="kt"><a href="../Protocols/Diffable.html">Diffable</a></span></code></pre> <pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">Method</span><span class="p">:</span> <span class="kt">NSCoding</span></code></pre> </div> </div> <p>Describes method</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)SwiftMethod(py)name"></a> <a name="//apple_ref/swift/Property/name" class="dashAnchor"></a> <a class="token" href="#/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)name">name</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Full method name, including generic constraints, i.e. <code>foo<T>(bar: T)</code></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">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="/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)selectorName"></a> <a name="//apple_ref/swift/Property/selectorName" class="dashAnchor"></a> <a class="token" href="#/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)selectorName">selectorName</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Method name including arguments names, i.e. <code>foo(bar:)</code></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">selectorName</span><span class="p">:</span> <span class="kt">String</span></code></pre> </div> </div> </section> </div> </li> <li class="item"> <div> <code> <a name="/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)shortName"></a> <a name="//apple_ref/swift/Property/shortName" class="dashAnchor"></a> <a class="token" href="#/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)shortName">shortName</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Method name without arguments names and parentheses, i.e. <code>foo<T></code></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">shortName</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)SwiftMethod(py)callName"></a> <a name="//apple_ref/swift/Property/callName" class="dashAnchor"></a> <a class="token" href="#/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)callName">callName</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Method name without arguments names, parentheses and generic types, i.e. <code>foo</code> (can be used to generate code for method call)</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">callName</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)SwiftMethod(py)parameters"></a> <a name="//apple_ref/swift/Property/parameters" class="dashAnchor"></a> <a class="token" href="#/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)parameters">parameters</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Method parameters</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">parameters</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/MethodParameter.html">MethodParameter</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)SwiftMethod(py)returnTypeName"></a> <a name="//apple_ref/swift/Property/returnTypeName" class="dashAnchor"></a> <a class="token" href="#/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)returnTypeName">returnTypeName</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Return value type name used in declaration, including generic constraints, i.e. <code>where T: Equatable</code></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">returnTypeName</span><span class="p">:</span> <span class="kt"><a href="../Classes/TypeName.html">TypeName</a></span></code></pre> </div> </div> </section> </div> </li> <li class="item"> <div> <code> <a name="/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)actualReturnTypeName"></a> <a name="//apple_ref/swift/Property/actualReturnTypeName" class="dashAnchor"></a> <a class="token" href="#/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)actualReturnTypeName">actualReturnTypeName</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Actual return value type name if declaration uses typealias, otherwise just a <code><a href="../Classes/Method.html#/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)returnTypeName">returnTypeName</a></code></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">actualReturnTypeName</span><span class="p">:</span> <span class="kt"><a href="../Classes/TypeName.html">TypeName</a></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)SwiftMethod(py)returnType"></a> <a name="//apple_ref/swift/Property/returnType" class="dashAnchor"></a> <a class="token" href="#/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)returnType">returnType</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Actual return 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">returnType</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)SwiftMethod(py)isOptionalReturnType"></a> <a name="//apple_ref/swift/Property/isOptionalReturnType" class="dashAnchor"></a> <a class="token" href="#/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)isOptionalReturnType">isOptionalReturnType</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Whether return value type is optional</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">isOptionalReturnType</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)SwiftMethod(py)isImplicitlyUnwrappedOptionalReturnType"></a> <a name="//apple_ref/swift/Property/isImplicitlyUnwrappedOptionalReturnType" class="dashAnchor"></a> <a class="token" href="#/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)isImplicitlyUnwrappedOptionalReturnType">isImplicitlyUnwrappedOptionalReturnType</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Whether return value 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 swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isImplicitlyUnwrappedOptionalReturnType</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)SwiftMethod(py)unwrappedReturnTypeName"></a> <a name="//apple_ref/swift/Property/unwrappedReturnTypeName" class="dashAnchor"></a> <a class="token" href="#/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)unwrappedReturnTypeName">unwrappedReturnTypeName</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Return value 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 swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">unwrappedReturnTypeName</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)SwiftMethod(py)isAsync"></a> <a name="//apple_ref/swift/Property/isAsync" class="dashAnchor"></a> <a class="token" href="#/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)isAsync">isAsync</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Whether method is async method</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">let</span> <span class="nv">isAsync</span><span class="p">:</span> <span class="kt">Bool</span></code></pre> </div> </div> </section> </div> </li> <li class="item"> <div> <code> <a name="/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)isDistributed"></a> <a name="//apple_ref/swift/Property/isDistributed" class="dashAnchor"></a> <a class="token" href="#/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)isDistributed">isDistributed</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Whether method is distributed</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">isDistributed</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)SwiftMethod(py)throws"></a> <a name="//apple_ref/swift/Property/throws" class="dashAnchor"></a> <a class="token" href="#/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)throws">throws</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Whether method throws</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="kd">let</span> <span class="p">`</span><span class="nv">throws</span><span class="p">`:</span> <span class="kt">Bool</span></code></pre> </div> </div> </section> </div> </li> <li class="item"> <div> <code> <a name="/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)throwsTypeName"></a> <a name="//apple_ref/swift/Property/throwsTypeName" class="dashAnchor"></a> <a class="token" href="#/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)throwsTypeName">throwsTypeName</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Type of thrown error if specified</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">let</span> <span class="nv">throwsTypeName</span><span class="p">:</span> <span class="kt"><a href="../Classes/TypeName.html">TypeName</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)SwiftMethod(py)isThrowsTypeGeneric"></a> <a name="//apple_ref/swift/Property/isThrowsTypeGeneric" class="dashAnchor"></a> <a class="token" href="#/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)isThrowsTypeGeneric">isThrowsTypeGeneric</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Return if the throwsType is generic</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">isThrowsTypeGeneric</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)SwiftMethod(py)rethrows"></a> <a name="//apple_ref/swift/Property/rethrows" class="dashAnchor"></a> <a class="token" href="#/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)rethrows">rethrows</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Whether method rethrows</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="kd">let</span> <span class="p">`</span><span class="nv">rethrows</span><span class="p">`:</span> <span class="kt">Bool</span></code></pre> </div> </div> </section> </div> </li> <li class="item"> <div> <code> <a name="/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)accessLevel"></a> <a name="//apple_ref/swift/Property/accessLevel" class="dashAnchor"></a> <a class="token" href="#/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)accessLevel">accessLevel</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Method access level, i.e. <code>internal</code>, <code>private</code>, <code>fileprivate</code>, <code>public</code>, <code>open</code></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">let</span> <span class="nv">accessLevel</span><span class="p">:</span> <span class="kt">String</span></code></pre> </div> </div> </section> </div> </li> <li class="item"> <div> <code> <a name="/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)isStatic"></a> <a name="//apple_ref/swift/Property/isStatic" class="dashAnchor"></a> <a class="token" href="#/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)isStatic">isStatic</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Whether method is a static method</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">let</span> <span class="nv">isStatic</span><span class="p">:</span> <span class="kt">Bool</span></code></pre> </div> </div> </section> </div> </li> <li class="item"> <div> <code> <a name="/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)isClass"></a> <a name="//apple_ref/swift/Property/isClass" class="dashAnchor"></a> <a class="token" href="#/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)isClass">isClass</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Whether method is a class method</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">let</span> <span class="nv">isClass</span><span class="p">:</span> <span class="kt">Bool</span></code></pre> </div> </div> </section> </div> </li> <li class="item"> <div> <code> <a name="/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)isInitializer"></a> <a name="//apple_ref/swift/Property/isInitializer" class="dashAnchor"></a> <a class="token" href="#/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)isInitializer">isInitializer</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Whether method is an initializer</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">isInitializer</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)SwiftMethod(py)isDeinitializer"></a> <a name="//apple_ref/swift/Property/isDeinitializer" class="dashAnchor"></a> <a class="token" href="#/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)isDeinitializer">isDeinitializer</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Whether method is an deinitializer</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">isDeinitializer</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)SwiftMethod(py)isFailableInitializer"></a> <a name="//apple_ref/swift/Property/isFailableInitializer" class="dashAnchor"></a> <a class="token" href="#/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)isFailableInitializer">isFailableInitializer</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Whether method is a failable initializer</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">let</span> <span class="nv">isFailableInitializer</span><span class="p">:</span> <span class="kt">Bool</span></code></pre> </div> </div> </section> </div> </li> <li class="item"> <div> <code> <a name="/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)isConvenienceInitializer"></a> <a name="//apple_ref/swift/Property/isConvenienceInitializer" class="dashAnchor"></a> <a class="token" href="#/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)isConvenienceInitializer">isConvenienceInitializer</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Whether method is a convenience initializer</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">isConvenienceInitializer</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)SwiftMethod(py)isRequired"></a> <a name="//apple_ref/swift/Property/isRequired" class="dashAnchor"></a> <a class="token" href="#/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)isRequired">isRequired</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Whether method is required</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">isRequired</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)SwiftMethod(py)isFinal"></a> <a name="//apple_ref/swift/Property/isFinal" class="dashAnchor"></a> <a class="token" href="#/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)isFinal">isFinal</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Whether method is final</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">isFinal</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)SwiftMethod(py)isMutating"></a> <a name="//apple_ref/swift/Property/isMutating" class="dashAnchor"></a> <a class="token" href="#/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)isMutating">isMutating</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Whether method is mutating</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">isMutating</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)SwiftMethod(py)isGeneric"></a> <a name="//apple_ref/swift/Property/isGeneric" class="dashAnchor"></a> <a class="token" href="#/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)isGeneric">isGeneric</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Whether method is generic</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">isGeneric</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)SwiftMethod(py)isOptional"></a> <a name="//apple_ref/swift/Property/isOptional" class="dashAnchor"></a> <a class="token" href="#/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)isOptional">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 method is optional (in an Objective-C protocol)</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">isOptional</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)SwiftMethod(py)isNonisolated"></a> <a name="//apple_ref/swift/Property/isNonisolated" class="dashAnchor"></a> <a class="token" href="#/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)isNonisolated">isNonisolated</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Whether method is nonisolated (this modifier only applies to actor methods)</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">isNonisolated</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)SwiftMethod(py)isDynamic"></a> <a name="//apple_ref/swift/Property/isDynamic" class="dashAnchor"></a> <a class="token" href="#/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)isDynamic">isDynamic</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Whether method is dynamic</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">isDynamic</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)SwiftMethod(py)annotations"></a> <a name="//apple_ref/swift/Property/annotations" class="dashAnchor"></a> <a class="token" href="#/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)annotations">annotations</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Annotations, that were created with // sourcery: annotation1, other = “annotation value”, alterantive = 2</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">let</span> <span class="nv">annotations</span><span class="p">:</span> <span class="kt"><a href="../Other%20Typealiases.html#/s:15SourceryRuntime11Annotationsa">Annotations</a></span></code></pre> </div> </div> </section> </div> </li> <li class="item"> <div> <code> <a name="/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)documentation"></a> <a name="//apple_ref/swift/Property/documentation" class="dashAnchor"></a> <a class="token" href="#/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)documentation">documentation</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="k">let</span> <span class="nv">documentation</span><span class="p">:</span> <span class="kt"><a href="../Other%20Typealiases.html#/s:15SourceryRuntime13Documentationa">Documentation</a></span></code></pre> </div> </div> </section> </div> </li> <li class="item"> <div> <code> <a name="/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)definedInTypeName"></a> <a name="//apple_ref/swift/Property/definedInTypeName" class="dashAnchor"></a> <a class="token" href="#/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)definedInTypeName">definedInTypeName</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Reference to type name where the method is defined, nil if defined outside of any <code>enum</code>, <code>struct</code>, <code>class</code> etc</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">let</span> <span class="nv">definedInTypeName</span><span class="p">:</span> <span class="kt"><a href="../Classes/TypeName.html">TypeName</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)SwiftMethod(py)actualDefinedInTypeName"></a> <a name="//apple_ref/swift/Property/actualDefinedInTypeName" class="dashAnchor"></a> <a class="token" href="#/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)actualDefinedInTypeName">actualDefinedInTypeName</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Reference to actual type name where the method is defined if declaration uses typealias, otherwise just a <code><a href="../Classes/Method.html#/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)definedInTypeName">definedInTypeName</a></code></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">actualDefinedInTypeName</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="p">}</span></code></pre> </div> </div> </section> </div> </li> <li class="item"> <div> <code> <a name="/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)definedInType"></a> <a name="//apple_ref/swift/Property/definedInType" class="dashAnchor"></a> <a class="token" href="#/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)definedInType">definedInType</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Reference to actual type where the object is defined, nil if defined outside of any <code>enum</code>, <code>struct</code>, <code>class</code> etc or type is unknown</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">definedInType</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)SwiftMethod(py)attributes"></a> <a name="//apple_ref/swift/Property/attributes" class="dashAnchor"></a> <a class="token" href="#/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)attributes">attributes</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Method attributes, i.e. <code>@discardableResult</code></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">let</span> <span class="nv">attributes</span><span class="p">:</span> <span class="kt">AttributeList</span></code></pre> </div> </div> </section> </div> </li> <li class="item"> <div> <code> <a name="/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)modifiers"></a> <a name="//apple_ref/swift/Property/modifiers" class="dashAnchor"></a> <a class="token" href="#/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)modifiers">modifiers</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>Method modifiers, i.e. <code>private</code></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">let</span> <span class="nv">modifiers</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Other%20Typealiases.html#/s:15SourceryRuntime0A8Modifiera">SourceryModifier</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)SwiftMethod(py)genericRequirements"></a> <a name="//apple_ref/swift/Property/genericRequirements" class="dashAnchor"></a> <a class="token" href="#/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)genericRequirements">genericRequirements</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>list of generic requirements</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">genericRequirements</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/GenericRequirement.html">GenericRequirement</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)SwiftMethod(py)genericParameters"></a> <a name="//apple_ref/swift/Property/genericParameters" class="dashAnchor"></a> <a class="token" href="#/c:@M@SourceryRuntime@objc(cs)SwiftMethod(py)genericParameters">genericParameters</a> </code> </div> <div class="height-container"> <div class="pointer-container"></div> <section class="section"> <div class="pointer"></div> <div class="abstract"> <p>List of generic parameters</p> <ul> <li>Example:</li> </ul> <pre class="highlight swift"><code> <span class="kd">func</span> <span class="n">method</span><span class="o"><</span><span class="kt">GenericParameter</span><span class="o">></span><span class="p">(</span><span class="nv">foo</span><span class="p">:</span> <span class="kt">GenericParameter</span><span class="p">)</span> <span class="o">^</span> <span class="o">~</span> <span class="n">a</span> <span class="n">generic</span> <span class="n">parameter</span> </code></pre> </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">genericParameters</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/GenericParameter.html">GenericParameter</a></span><span class="p">]</span></code></pre> </div> </div> </section> </div> </li> <li class="item"> <div> <code> <a name="/s:15SourceryRuntime8DiffableP11diffAgainstyAA0C6ResultCypSgF"></a> <a name="//apple_ref/swift/Method/diffAgainst(_:)" class="dashAnchor"></a> <a class="token" href="#/s:15SourceryRuntime8DiffableP11diffAgainstyAA0C6ResultCypSgF">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="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>