-
-
Notifications
You must be signed in to change notification settings - Fork 240
/
Structs.html
319 lines (292 loc) 路 18.2 KB
/
Structs.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
<!DOCTYPE html>
<html lang="en">
<head>
<title>Structures 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/Section/Structures" class="dashAnchor"></a>
<a title="Structures Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">DifferenceKit Docs</a> (100% documented)</p>
<p class="header-right"><a href="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/ra1028/DifferenceKit"><img src="img/gh.png"/>View on GitHub</a></p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="index.html">DifferenceKit Reference</a>
<img id="carat" src="img/carat.png" />
Structures Reference
</p>
</div>
<div class="content-wrapper">
<nav class="sidebar">
<ul class="nav-groups">
<li class="nav-group-name">
<a href="Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Extensions/UICollectionView.html">UICollectionView</a>
</li>
<li class="nav-group-task">
<a href="Extensions/UITableView.html">UITableView</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Protocols/Differentiable.html">Differentiable</a>
</li>
<li class="nav-group-task">
<a href="Protocols/DifferentiableSection.html">DifferentiableSection</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Structs/AnyDifferentiable.html">AnyDifferentiable</a>
</li>
<li class="nav-group-task">
<a href="Structs/Changeset.html">Changeset</a>
</li>
<li class="nav-group-task">
<a href="Structs/ElementPath.html">ElementPath</a>
</li>
<li class="nav-group-task">
<a href="Structs/Section.html">Section</a>
</li>
<li class="nav-group-task">
<a href="Structs/StagedChangeset.html">StagedChangeset</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<h1>Structures</h1>
<p>The following structures are available globally.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:13DifferenceKit15StagedChangesetV"></a>
<a name="//apple_ref/swift/Struct/StagedChangeset" class="dashAnchor"></a>
<a class="token" href="#/s:13DifferenceKit15StagedChangesetV">StagedChangeset</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>An ordered collection of <code><a href="Structs/Changeset.html">Changeset</a></code> as staged set of changes in the sectioned collection.</p>
<p>The order is representing the stages of changesets.</p>
<p>We know that there are combination of changes that crash when applied simultaneously
in batch-updates of UI such as UITableView or UICollectionView.
The <code>StagedChangeset</code> created from the two collection is split at the minimal stages
that can be perform batch-updates with no crashes.</p>
<p>Example for calculating differences between the two linear collections.</p>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">String</span><span class="p">:</span> <span class="nf">Differentiable</span> <span class="p">{}</span>
<span class="k">let</span> <span class="nv">source</span> <span class="o">=</span> <span class="p">[</span><span class="s">"A"</span><span class="p">,</span> <span class="s">"B"</span><span class="p">,</span> <span class="s">"C"</span><span class="p">]</span>
<span class="k">let</span> <span class="nv">target</span> <span class="o">=</span> <span class="p">[</span><span class="s">"B"</span><span class="p">,</span> <span class="s">"C"</span><span class="p">,</span> <span class="s">"D"</span><span class="p">]</span>
<span class="k">let</span> <span class="nv">changeset</span> <span class="o">=</span> <span class="nf">StagedChangeset</span><span class="p">(</span><span class="nv">source</span><span class="p">:</span> <span class="n">source</span><span class="p">,</span> <span class="nv">target</span><span class="p">:</span> <span class="n">target</span><span class="p">)</span>
<span class="nf">print</span><span class="p">(</span><span class="n">changeset</span><span class="o">.</span><span class="n">isEmpty</span><span class="p">)</span> <span class="c1">// prints "false"</span>
</code></pre>
<p>Example for calculating differences between the two sectioned collections.</p>
<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">source</span> <span class="o">=</span> <span class="p">[</span>
<span class="nf">Section</span><span class="p">(</span><span class="nv">model</span><span class="p">:</span> <span class="s">"A"</span><span class="p">,</span> <span class="nv">elements</span><span class="p">:</span> <span class="p">[</span><span class="s">"馃槈"</span><span class="p">]),</span>
<span class="p">]</span>
<span class="k">let</span> <span class="nv">target</span> <span class="o">=</span> <span class="p">[</span>
<span class="nf">Section</span><span class="p">(</span><span class="nv">model</span><span class="p">:</span> <span class="s">"A"</span><span class="p">,</span> <span class="nv">elements</span><span class="p">:</span> <span class="p">[</span><span class="s">"馃槈, 馃樅"</span><span class="p">]),</span>
<span class="nf">Section</span><span class="p">(</span><span class="nv">model</span><span class="p">:</span> <span class="s">"B"</span><span class="p">,</span> <span class="nv">elements</span><span class="p">:</span> <span class="p">[</span><span class="s">"馃槳"</span><span class="p">])</span>
<span class="p">]</span>
<span class="k">let</span> <span class="nv">changeset</span> <span class="o">=</span> <span class="nf">StagedChangeset</span><span class="p">(</span><span class="nv">source</span><span class="p">:</span> <span class="n">sectionedSource</span><span class="p">,</span> <span class="nv">target</span><span class="p">:</span> <span class="n">sectionedTarget</span><span class="p">)</span>
<span class="nf">print</span><span class="p">(</span><span class="n">changeset</span><span class="o">.</span><span class="n">isEmpty</span><span class="p">)</span> <span class="c1">// prints "false"</span>
</code></pre>
<a href="Structs/StagedChangeset.html" class="slightly-smaller">See more</a>
</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">struct</span> <span class="kt">StagedChangeset</span><span class="o"><</span><span class="kt">Collection</span><span class="o">></span> <span class="k">where</span> <span class="kt">Collection</span> <span class="p">:</span> <span class="kt">Collection</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:13DifferenceKit17AnyDifferentiableV"></a>
<a name="//apple_ref/swift/Struct/AnyDifferentiable" class="dashAnchor"></a>
<a class="token" href="#/s:13DifferenceKit17AnyDifferentiableV">AnyDifferentiable</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>A type-erased differentiable value.</p>
<p>The <code>AnyDifferentiable</code> type hides the specific underlying types.
<code>DifferenceIdentifier</code> type is erased by <code>AnyHashable</code>.
The comparisons of whether has updated is forwards to an underlying differentiable value.</p>
<p>You can store mixed-type elements in collection that require <code><a href="Protocols/Differentiable.html">Differentiable</a></code> conformance by
wrapping mixed-type elements in <code>AnyDifferentiable</code>:</p>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">String</span><span class="p">:</span> <span class="nf">Differentiable</span> <span class="p">{}</span>
<span class="kd">extension</span> <span class="kt">Int</span><span class="p">:</span> <span class="nf">Differentiable</span> <span class="p">{}</span>
<span class="k">let</span> <span class="nv">source</span> <span class="o">=</span> <span class="p">[</span>
<span class="nf">AnyDifferentiable</span><span class="p">(</span><span class="s">"ABC"</span><span class="p">),</span>
<span class="nf">AnyDifferentiable</span><span class="p">(</span><span class="mi">100</span><span class="p">)</span>
<span class="p">]</span>
<span class="k">let</span> <span class="nv">target</span> <span class="o">=</span> <span class="p">[</span>
<span class="nf">AnyDifferentiable</span><span class="p">(</span><span class="s">"ABC"</span><span class="p">),</span>
<span class="nf">AnyDifferentiable</span><span class="p">(</span><span class="mi">100</span><span class="p">),</span>
<span class="nf">AnyDifferentiable</span><span class="p">(</span><span class="mi">200</span><span class="p">)</span>
<span class="p">]</span>
<span class="k">let</span> <span class="nv">changeset</span> <span class="o">=</span> <span class="nf">StagedChangeset</span><span class="p">(</span><span class="nv">source</span><span class="p">:</span> <span class="n">source</span><span class="p">,</span> <span class="nv">target</span><span class="p">:</span> <span class="n">target</span><span class="p">)</span>
<span class="nf">print</span><span class="p">(</span><span class="n">changeset</span><span class="o">.</span><span class="n">isEmpty</span><span class="p">)</span> <span class="c1">// prints "false"</span>
</code></pre>
<a href="Structs/AnyDifferentiable.html" class="slightly-smaller">See more</a>
</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">struct</span> <span class="kt">AnyDifferentiable</span> <span class="p">:</span> <span class="kt"><a href="Protocols/Differentiable.html">Differentiable</a></span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:13DifferenceKit9ChangesetV"></a>
<a name="//apple_ref/swift/Struct/Changeset" class="dashAnchor"></a>
<a class="token" href="#/s:13DifferenceKit9ChangesetV">Changeset</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>A set of changes in the sectioned collection.</p>
<p>Changes to the section of the linear collection should be empty.</p>
<p>Notice that the value of the changes represents offsets of collection not index.
Since offsets are unordered, order is ignored when comparing two <code>Changeset</code>s.</p>
<a href="Structs/Changeset.html" class="slightly-smaller">See more</a>
</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">struct</span> <span class="kt">Changeset</span><span class="o"><</span><span class="kt">Collection</span><span class="o">></span> <span class="k">where</span> <span class="kt">Collection</span> <span class="p">:</span> <span class="kt">Collection</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:13DifferenceKit11ElementPathV"></a>
<a name="//apple_ref/swift/Struct/ElementPath" class="dashAnchor"></a>
<a class="token" href="#/s:13DifferenceKit11ElementPathV">ElementPath</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Represents the path to a specific element in a tree of nested collections.</p>
<div class="aside aside-note">
<p class="aside-title">Note</p>
<code>Foundation.IndexPath</code> is disadvantageous in performance.
</div>
<a href="Structs/ElementPath.html" class="slightly-smaller">See more</a>
</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">struct</span> <span class="kt">ElementPath</span> <span class="p">:</span> <span class="kt">Hashable</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:13DifferenceKit7SectionV"></a>
<a name="//apple_ref/swift/Struct/Section" class="dashAnchor"></a>
<a class="token" href="#/s:13DifferenceKit7SectionV">Section</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>A generic differentiable section.</p>
<p>Arrays are can not be identify each one and comparing whether has updated from other one.
Section is a generic wrapper to hold a model and elements to allow it.</p>
<a href="Structs/Section.html" class="slightly-smaller">See more</a>
</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">struct</span> <span class="kt">Section</span><span class="o"><</span><span class="kt">Model</span><span class="p">,</span> <span class="kt">Element</span><span class="o">></span> <span class="p">:</span> <span class="kt"><a href="Protocols/DifferentiableSection.html">DifferentiableSection</a></span> <span class="k">where</span> <span class="kt">Model</span> <span class="p">:</span> <span class="kt"><a href="Protocols/Differentiable.html">Differentiable</a></span><span class="p">,</span> <span class="kt">Element</span> <span class="p">:</span> <span class="kt"><a href="Protocols/Differentiable.html">Differentiable</a></span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>© 2018 <a class="link" href="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/ra1028" target="_blank" rel="external">Ryo Aoyama</a>. All rights reserved. (Last updated: 2018-08-06)</p>
<p>Generated by <a class="link" href="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/realm/jazzy" target="_blank" rel="external">jazzy 鈾櫕 v0.9.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</div>
</html>