This repository was archived by the owner on Feb 2, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 51
/
Copy pathStructs.html
173 lines (167 loc) · 6.97 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
<!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>
<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/Section/Structures" class="dashAnchor"></a>
<a title="Structures Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">SwiftCoroutine 2.1.9 Docs</a> (88% documented)</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">SwiftCoroutine 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="Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Classes/CoChannel.html">CoChannel</a>
</li>
<li class="nav-group-task">
<a href="Classes/CoChannel/BufferType.html">– BufferType</a>
</li>
<li class="nav-group-task">
<a href="Classes/CoChannel/Receiver.html">– Receiver</a>
</li>
<li class="nav-group-task">
<a href="Classes/CoChannel/Sender.html">– Sender</a>
</li>
<li class="nav-group-task">
<a href="Classes/CoFuture.html">CoFuture</a>
</li>
<li class="nav-group-task">
<a href="Classes/CoPromise.html">CoPromise</a>
</li>
<li class="nav-group-task">
<a href="Classes/CoScope.html">CoScope</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Enums/CoChannelError.html">CoChannelError</a>
</li>
<li class="nav-group-task">
<a href="Enums/CoFutureError.html">CoFutureError</a>
</li>
<li class="nav-group-task">
<a href="Enums/CoroutineError.html">CoroutineError</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Extensions/DispatchQueue.html">DispatchQueue</a>
</li>
<li class="nav-group-task">
<a href="Extensions/Publisher.html">Publisher</a>
</li>
<li class="nav-group-task">
<a href="Extensions/URLSession.html">URLSession</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/CoCancellable.html">CoCancellable</a>
</li>
<li class="nav-group-task">
<a href="Protocols/CoroutineScheduler.html">CoroutineScheduler</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/Coroutine.html">Coroutine</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:14SwiftCoroutine0B0V"></a>
<a name="//apple_ref/swift/Struct/Coroutine" class="dashAnchor"></a>
<a class="token" href="#/s:14SwiftCoroutine0B0V">Coroutine</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Additional struct with utility methods to work with coroutines.</p>
<div class="aside aside-important">
<p class="aside-title">Important</p>
All <code>await()</code> methods must be called inside a coroutine.
</div>
<p>To check if inside a coroutine, use <code><a href="Structs/Coroutine.html#/s:14SwiftCoroutine0B0V08isInsideB0SbvpZ">Coroutine.isInsideCoroutine</a></code>.
If you call <code>await()</code> outside the coroutine, the precondition inside these methods will fail, and you'ill get an error.
In -Ounchecked builds, where preconditions are not evaluated to avoid any crashes,
a thread-blocking mechanism is used for waiting the result.</p>
<a href="Structs/Coroutine.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">Coroutine</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>© 2020 <a class="link" href="https://github.com/belozierov/SwiftCoroutine" target="_blank" rel="external">Alex Belozierov</a>. All rights reserved. (Last updated: 2020-07-11)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</div>
</html>