Add PassthroughAsyncSequence and ThrowingPassthroughAsyncSequence (#7)

* Add PassthroughAsyncSequence and ThrowingPassthroughAsyncSequence * Update documentation
reddavis · Jan 7, 2022 · f1c42d2 · f1c42d2
1 parent 598bed6
commit f1c42d2
Show file tree

Hide file tree

Showing 60 changed files with 2,466 additions and 48 deletions.
diff --git a/.documentation/Extensions.html b/.documentation/Extensions.html
@@ -85,6 +85,9 @@
               <li class="nav-group-task">
                 <a href="Structs/MergeAsyncSequence.html">MergeAsyncSequence</a>
               </li>
+              <li class="nav-group-task">
+                <a href="Structs/PassthroughAsyncSequence.html">PassthroughAsyncSequence</a>
+              </li>
               <li class="nav-group-task">
                 <a href="Structs/RemoveDuplicatesAsyncSequence.html">RemoveDuplicatesAsyncSequence</a>
               </li>
@@ -97,6 +100,9 @@
               <li class="nav-group-task">
                 <a href="Structs/ThrottleAsyncSequence.html">ThrottleAsyncSequence</a>
               </li>
+              <li class="nav-group-task">
+                <a href="Structs/ThrowingPassthroughAsyncSequence.html">ThrowingPassthroughAsyncSequence</a>
+              </li>
               <li class="nav-group-task">
                 <a href="Structs/Zip3AsyncSequence.html">Zip3AsyncSequence</a>
               </li>
@@ -213,7 +219,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2022 <a class="link" href="" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2022-01-02)</p>
+          <p>&copy; 2022 <a class="link" href="" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2022-01-07)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
         </section>
       </article>

diff --git a/.documentation/Extensions/AsyncSequence.html b/.documentation/Extensions/AsyncSequence.html
@@ -85,6 +85,9 @@
               <li class="nav-group-task">
                 <a href="../Structs/MergeAsyncSequence.html">MergeAsyncSequence</a>
               </li>
+              <li class="nav-group-task">
+                <a href="../Structs/PassthroughAsyncSequence.html">PassthroughAsyncSequence</a>
+              </li>
               <li class="nav-group-task">
                 <a href="../Structs/RemoveDuplicatesAsyncSequence.html">RemoveDuplicatesAsyncSequence</a>
               </li>
@@ -97,6 +100,9 @@
               <li class="nav-group-task">
                 <a href="../Structs/ThrottleAsyncSequence.html">ThrottleAsyncSequence</a>
               </li>
+              <li class="nav-group-task">
+                <a href="../Structs/ThrowingPassthroughAsyncSequence.html">ThrowingPassthroughAsyncSequence</a>
+              </li>
               <li class="nav-group-task">
                 <a href="../Structs/Zip3AsyncSequence.html">Zip3AsyncSequence</a>
               </li>
@@ -1271,7 +1277,7 @@ <h4>Return Value</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2022 <a class="link" href="" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2022-01-02)</p>
+          <p>&copy; 2022 <a class="link" href="" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2022-01-07)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
         </section>
       </article>

diff --git a/.documentation/Extensions/AsyncStream.html b/.documentation/Extensions/AsyncStream.html
@@ -85,6 +85,9 @@
               <li class="nav-group-task">
                 <a href="../Structs/MergeAsyncSequence.html">MergeAsyncSequence</a>
               </li>
+              <li class="nav-group-task">
+                <a href="../Structs/PassthroughAsyncSequence.html">PassthroughAsyncSequence</a>
+              </li>
               <li class="nav-group-task">
                 <a href="../Structs/RemoveDuplicatesAsyncSequence.html">RemoveDuplicatesAsyncSequence</a>
               </li>
@@ -97,6 +100,9 @@
               <li class="nav-group-task">
                 <a href="../Structs/ThrottleAsyncSequence.html">ThrottleAsyncSequence</a>
               </li>
+              <li class="nav-group-task">
+                <a href="../Structs/ThrowingPassthroughAsyncSequence.html">ThrowingPassthroughAsyncSequence</a>
+              </li>
               <li class="nav-group-task">
                 <a href="../Structs/Zip3AsyncSequence.html">Zip3AsyncSequence</a>
               </li>
@@ -262,7 +268,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2022 <a class="link" href="" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2022-01-02)</p>
+          <p>&copy; 2022 <a class="link" href="" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2022-01-07)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
         </section>
       </article>

diff --git a/.documentation/Extensions/AsyncStream/Continuation.html b/.documentation/Extensions/AsyncStream/Continuation.html
@@ -85,6 +85,9 @@
               <li class="nav-group-task">
                 <a href="../../Structs/MergeAsyncSequence.html">MergeAsyncSequence</a>
               </li>
+              <li class="nav-group-task">
+                <a href="../../Structs/PassthroughAsyncSequence.html">PassthroughAsyncSequence</a>
+              </li>
               <li class="nav-group-task">
                 <a href="../../Structs/RemoveDuplicatesAsyncSequence.html">RemoveDuplicatesAsyncSequence</a>
               </li>
@@ -97,6 +100,9 @@
               <li class="nav-group-task">
                 <a href="../../Structs/ThrottleAsyncSequence.html">ThrottleAsyncSequence</a>
               </li>
+              <li class="nav-group-task">
+                <a href="../../Structs/ThrowingPassthroughAsyncSequence.html">ThrowingPassthroughAsyncSequence</a>
+              </li>
               <li class="nav-group-task">
                 <a href="../../Structs/Zip3AsyncSequence.html">Zip3AsyncSequence</a>
               </li>
@@ -174,7 +180,7 @@ <h4>Parameters</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2022 <a class="link" href="" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2022-01-02)</p>
+          <p>&copy; 2022 <a class="link" href="" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2022-01-07)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
         </section>
       </article>

diff --git a/.documentation/Extensions/AsyncThrowingStream.html b/.documentation/Extensions/AsyncThrowingStream.html
@@ -85,6 +85,9 @@
               <li class="nav-group-task">
                 <a href="../Structs/MergeAsyncSequence.html">MergeAsyncSequence</a>
               </li>
+              <li class="nav-group-task">
+                <a href="../Structs/PassthroughAsyncSequence.html">PassthroughAsyncSequence</a>
+              </li>
               <li class="nav-group-task">
                 <a href="../Structs/RemoveDuplicatesAsyncSequence.html">RemoveDuplicatesAsyncSequence</a>
               </li>
@@ -97,6 +100,9 @@
               <li class="nav-group-task">
                 <a href="../Structs/ThrottleAsyncSequence.html">ThrottleAsyncSequence</a>
               </li>
+              <li class="nav-group-task">
+                <a href="../Structs/ThrowingPassthroughAsyncSequence.html">ThrowingPassthroughAsyncSequence</a>
+              </li>
               <li class="nav-group-task">
                 <a href="../Structs/Zip3AsyncSequence.html">Zip3AsyncSequence</a>
               </li>
@@ -262,7 +268,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2022 <a class="link" href="" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2022-01-02)</p>
+          <p>&copy; 2022 <a class="link" href="" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2022-01-07)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
         </section>
       </article>

diff --git a/.documentation/Extensions/AsyncThrowingStream/Continuation.html b/.documentation/Extensions/AsyncThrowingStream/Continuation.html
@@ -85,6 +85,9 @@
               <li class="nav-group-task">
                 <a href="../../Structs/MergeAsyncSequence.html">MergeAsyncSequence</a>
               </li>
+              <li class="nav-group-task">
+                <a href="../../Structs/PassthroughAsyncSequence.html">PassthroughAsyncSequence</a>
+              </li>
               <li class="nav-group-task">
                 <a href="../../Structs/RemoveDuplicatesAsyncSequence.html">RemoveDuplicatesAsyncSequence</a>
               </li>
@@ -97,6 +100,9 @@
               <li class="nav-group-task">
                 <a href="../../Structs/ThrottleAsyncSequence.html">ThrottleAsyncSequence</a>
               </li>
+              <li class="nav-group-task">
+                <a href="../../Structs/ThrowingPassthroughAsyncSequence.html">ThrowingPassthroughAsyncSequence</a>
+              </li>
               <li class="nav-group-task">
                 <a href="../../Structs/Zip3AsyncSequence.html">Zip3AsyncSequence</a>
               </li>
@@ -174,7 +180,7 @@ <h4>Parameters</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2022 <a class="link" href="" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2022-01-02)</p>
+          <p>&copy; 2022 <a class="link" href="" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2022-01-07)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
         </section>
       </article>

diff --git a/.documentation/Structs.html b/.documentation/Structs.html
@@ -85,6 +85,9 @@
               <li class="nav-group-task">
                 <a href="Structs/MergeAsyncSequence.html">MergeAsyncSequence</a>
               </li>
+              <li class="nav-group-task">
+                <a href="Structs/PassthroughAsyncSequence.html">PassthroughAsyncSequence</a>
+              </li>
               <li class="nav-group-task">
                 <a href="Structs/RemoveDuplicatesAsyncSequence.html">RemoveDuplicatesAsyncSequence</a>
               </li>
@@ -97,6 +100,9 @@
               <li class="nav-group-task">
                 <a href="Structs/ThrottleAsyncSequence.html">ThrottleAsyncSequence</a>
               </li>
+              <li class="nav-group-task">
+                <a href="Structs/ThrowingPassthroughAsyncSequence.html">ThrowingPassthroughAsyncSequence</a>
+              </li>
               <li class="nav-group-task">
                 <a href="Structs/Zip3AsyncSequence.html">Zip3AsyncSequence</a>
               </li>
@@ -565,6 +571,49 @@ <h4>Declaration</h4>
                     </section>
                   </div>
                 </li>
+                <li class="item">
+                  <div>
+                    <code>
+                    <a name="/s:10Asynchrone24PassthroughAsyncSequenceV"></a>
+                    <a name="//apple_ref/swift/Struct/PassthroughAsyncSequence" class="dashAnchor"></a>
+                    <a class="token" href="#/s:10Asynchrone24PassthroughAsyncSequenceV">PassthroughAsyncSequence</a>
+                    </code>
+                  </div>
+                  <div class="height-container">
+                    <div class="pointer-container"></div>
+                    <section class="section">
+                      <div class="pointer"></div>
+                      <div class="abstract">
+                        <p>A async sequence that broadcasts elements.</p>
+<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">sequence</span> <span class="o">=</span> <span class="kt">PassthroughAsyncSequence</span><span class="o">&lt;</span><span class="kt">Int</span><span class="o">&gt;</span><span class="p">()</span>
+<span class="n">sequence</span><span class="o">.</span><span class="nf">yield</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
+<span class="n">sequence</span><span class="o">.</span><span class="nf">yield</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
+<span class="n">sequence</span><span class="o">.</span><span class="nf">yield</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
+<span class="n">sequence</span><span class="o">.</span><span class="nf">finish</span><span class="p">()</span>
+
+<span class="k">for</span> <span class="k">await</span> <span class="n">value</span> <span class="k">in</span> <span class="n">sequence</span> <span class="p">{</span>
+    <span class="nf">print</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
+<span class="p">}</span>
+
+<span class="c1">// Prints:</span>
+<span class="c1">// 0</span>
+<span class="c1">// 1</span>
+<span class="c1">// 2</span>
+</code></pre>
+
+                        <a href="Structs/PassthroughAsyncSequence.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">PassthroughAsyncSequence</span><span class="o">&lt;</span><span class="kt">Element</span><span class="o">&gt;</span> <span class="p">:</span> <span class="kt">AsyncSequence</span></code></pre>
+
+                        </div>
+                      </div>
+                    </section>
+                  </div>
+                </li>
                 <li class="item">
                   <div>
                     <code>
@@ -764,6 +813,54 @@ <h4>Declaration</h4>
                     </section>
                   </div>
                 </li>
+                <li class="item">
+                  <div>
+                    <code>
+                    <a name="/s:10Asynchrone32ThrowingPassthroughAsyncSequenceV"></a>
+                    <a name="//apple_ref/swift/Struct/ThrowingPassthroughAsyncSequence" class="dashAnchor"></a>
+                    <a class="token" href="#/s:10Asynchrone32ThrowingPassthroughAsyncSequenceV">ThrowingPassthroughAsyncSequence</a>
+                    </code>
+                  </div>
+                  <div class="height-container">
+                    <div class="pointer-container"></div>
+                    <section class="section">
+                      <div class="pointer"></div>
+                      <div class="abstract">
+                        <p>A async sequence that broadcasts elements.</p>
+<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">sequence</span> <span class="o">=</span> <span class="kt">ThrowingPassthroughAsyncSequence</span><span class="o">&lt;</span><span class="kt">Int</span><span class="o">&gt;</span><span class="p">()</span>
+<span class="n">sequence</span><span class="o">.</span><span class="nf">yield</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
+<span class="n">sequence</span><span class="o">.</span><span class="nf">yield</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
+<span class="n">sequence</span><span class="o">.</span><span class="nf">yield</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
+<span class="n">sequence</span><span class="o">.</span><span class="nf">finish</span><span class="p">(</span><span class="nv">throwing</span><span class="p">:</span> <span class="kt">TestError</span><span class="p">())</span>
+
+<span class="k">do</span> <span class="p">{</span>
+    <span class="k">for</span> <span class="k">try</span> <span class="k">await</span> <span class="n">value</span> <span class="k">in</span> <span class="n">sequence</span> <span class="p">{</span>
+      <span class="nf">print</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
+    <span class="p">}</span>
+<span class="p">}</span> <span class="k">catch</span> <span class="p">{</span>
+    <span class="nf">print</span><span class="p">(</span><span class="s">"Error!"</span><span class="p">)</span>
+<span class="p">}</span>
+
+<span class="c1">// Prints:</span>
+<span class="c1">// 0</span>
+<span class="c1">// 1</span>
+<span class="c1">// 2</span>
+<span class="c1">// Error!</span>
+</code></pre>
+
+                        <a href="Structs/ThrowingPassthroughAsyncSequence.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">ThrowingPassthroughAsyncSequence</span><span class="o">&lt;</span><span class="kt">Element</span><span class="o">&gt;</span> <span class="p">:</span> <span class="kt">AsyncSequence</span></code></pre>
+
+                        </div>
+                      </div>
+                    </section>
+                  </div>
+                </li>
                 <li class="item">
                   <div>
                     <code>
@@ -889,7 +986,7 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2022 <a class="link" href="" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2022-01-02)</p>
+          <p>&copy; 2022 <a class="link" href="" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2022-01-07)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
         </section>
       </article>

diff --git a/.documentation/Structs/AnyAsyncSequenceable.html b/.documentation/Structs/AnyAsyncSequenceable.html
@@ -85,6 +85,9 @@
               <li class="nav-group-task">
                 <a href="../Structs/MergeAsyncSequence.html">MergeAsyncSequence</a>
               </li>
+              <li class="nav-group-task">
+                <a href="../Structs/PassthroughAsyncSequence.html">PassthroughAsyncSequence</a>
+              </li>
               <li class="nav-group-task">
                 <a href="../Structs/RemoveDuplicatesAsyncSequence.html">RemoveDuplicatesAsyncSequence</a>
               </li>
@@ -97,6 +100,9 @@
               <li class="nav-group-task">
                 <a href="../Structs/ThrottleAsyncSequence.html">ThrottleAsyncSequence</a>
               </li>
+              <li class="nav-group-task">
+                <a href="../Structs/ThrowingPassthroughAsyncSequence.html">ThrowingPassthroughAsyncSequence</a>
+              </li>
               <li class="nav-group-task">
                 <a href="../Structs/Zip3AsyncSequence.html">Zip3AsyncSequence</a>
               </li>
@@ -324,7 +330,7 @@ <h4>Return Value</h4>
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2022 <a class="link" href="" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2022-01-02)</p>
+          <p>&copy; 2022 <a class="link" href="" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2022-01-07)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
         </section>
       </article>