Files
SwiftShell/docsets/SwiftShell.docset/Contents/Resources/Documents/Structs/LazySplitSequence.html
T
2017-04-05 22:34:43 +02:00

416 lines
24 KiB
HTML
Raw 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>LazySplitSequence Struct 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/Struct/LazySplitSequence" class="dashAnchor"></a>
<a title="LazySplitSequence Struct Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">SwiftShell Docs</a> (67% documented)</p>
<p class="header-right"><a href="https://github.com/kareman/SwiftShell"><img src="../img/gh.png"/>View on GitHub</a></p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="../index.html">SwiftShell Reference</a>
<img id="carat" src="../img/carat.png" />
LazySplitSequence Struct 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/AsyncCommand.html">AsyncCommand</a>
</li>
<li class="nav-group-task">
<a href="../Classes/FileHandleStream.html">FileHandleStream</a>
</li>
<li class="nav-group-task">
<a href="../Classes/MainContext.html">MainContext</a>
</li>
<li class="nav-group-task">
<a href="../Classes/RunOutput.html">RunOutput</a>
</li>
<li class="nav-group-task">
<a href="../Classes/StdoutStream.html">StdoutStream</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Global Variables.html">Global Variables</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Global Variables.html#/s:v10SwiftShell5FilesCSo11FileManager">Files</a>
</li>
<li class="nav-group-task">
<a href="../Global Variables.html#/s:v10SwiftShell4mainCS_11MainContext">main</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Enums.html">Enums</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Enums/CommandError.html">CommandError</a>
</li>
<li class="nav-group-task">
<a href="../Enums/FileError.html">FileError</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/FileHandle.html">FileHandle</a>
</li>
<li class="nav-group-task">
<a href="../Extensions/FileHandle.html">FileHandle</a>
</li>
<li class="nav-group-task">
<a href="../Extensions/LazyCollectionProtocol.html">LazyCollectionProtocol</a>
</li>
<li class="nav-group-task">
<a href="../Extensions/Process.html">Process</a>
</li>
<li class="nav-group-task">
<a href="../Extensions/String.html">String</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Functions.html">Functions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Functions.html#/s:F10SwiftShelloi1pFTV10Foundation3URLSS_S1_">+(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:F10SwiftShelloi2eeFTOS_12CommandErrorS0__Sb">==(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:F10SwiftShell4exitFTPs5Error_4fileSS4lineSi_Os5Never">exit(_:file:line:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:F10SwiftShell4exiturFT12errormessagex9errorcodeSi4fileSS4lineSi_Os5Never">exit(errormessage:errorcode:file:line:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:F10SwiftShell4openFzTSS8encodingVE10FoundationSS8Encoding_PS_14ReadableStream_">open(_:encoding:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:F10SwiftShell4openFzTV10Foundation3URL8encodingVES0_SS8Encoding_PS_14ReadableStream_">open(_:encoding:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:F10SwiftShell4openFzT10forWritingSS9overwriteSb8encodingVE10FoundationSS8Encoding_PS_14WritableStream_">open(forWriting:overwrite:encoding:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:F10SwiftShell4openFzT10forWritingV10Foundation3URL9overwriteSb8encodingVES0_SS8Encoding_PS_14WritableStream_">open(forWriting:overwrite:encoding:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:F10SwiftShell3runFTSSGSaP__13combineOutputSb_CS_9RunOutput">run(_:_:combineOutput:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:F10SwiftShell3runFT4bashSS13combineOutputSb_CS_9RunOutput">run(bash:combineOutput:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:F10SwiftShell11runAndPrintFztSSGSaP___T_">runAndPrint(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:F10SwiftShell11runAndPrintFzT4bashSS_T_">runAndPrint(bash:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:F10SwiftShell8runAsyncFTSSGSaP__4fileSS4lineSi_CS_12AsyncCommand">runAsync(_:_:file:line:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:F10SwiftShell8runAsyncFT4bashSS4fileSS4lineSi_CS_12AsyncCommand">runAsync(bash:file:line:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:F10SwiftShell7streamsFT_TPS_14WritableStream_PS_14ReadableStream__">streams()</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.html#/CommandRunning">CommandRunning</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/CommandRunning.html">CommandRunning</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/Context.html">Context</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/ReadableStream.html">ReadableStream</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/WritableStream.html">WritableStream</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Structs.html">Structs</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Structs/CustomContext.html">CustomContext</a>
</li>
<li class="nav-group-task">
<a href="../Structs/LazySplitSequence.html">LazySplitSequence</a>
</li>
<li class="nav-group-task">
<a href="../Structs/PartialSourceLazySplitSequence.html">PartialSourceLazySplitSequence</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<h1>LazySplitSequence</h1>
<div class="declaration">
<div class="language">
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">LazySplitSequence</span> <span class="o">&lt;</span><span class="kt">Base</span><span class="p">:</span> <span class="kt">Collection</span><span class="o">&gt;</span><span class="p">:</span> <span class="kt">IteratorProtocol</span><span class="p">,</span> <span class="kt">LazySequenceProtocol</span> <span class="k">where</span>
<span class="kt">Base</span><span class="o">.</span><span class="kt">Iterator</span><span class="o">.</span><span class="kt">Element</span><span class="p">:</span> <span class="kt">Equatable</span><span class="p">,</span>
<span class="kt">Base</span><span class="o">.</span><span class="kt">SubSequence</span><span class="p">:</span> <span class="kt">Collection</span><span class="p">,</span>
<span class="kt">Base</span><span class="o">.</span><span class="kt">SubSequence</span><span class="o">.</span><span class="kt">Iterator</span><span class="o">.</span><span class="kt">Element</span><span class="o">==</span><span class="kt">Base</span><span class="o">.</span><span class="kt">Iterator</span><span class="o">.</span><span class="kt">Element</span><span class="p">,</span>
<span class="kt">Base</span><span class="o">.</span><span class="kt">SubSequence</span><span class="o">==</span><span class="kt">Base</span><span class="o">.</span><span class="kt">SubSequence</span><span class="o">.</span><span class="kt">SubSequence</span></code></pre>
</div>
</div>
<p>A sequence from splitting a Collection lazily.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:vV10SwiftShell17LazySplitSequence9remainingGSqwx11SubSequence_"></a>
<a name="//apple_ref/swift/Property/remaining" class="dashAnchor"></a>
<a class="token" href="#/s:vV10SwiftShell17LazySplitSequence9remainingGSqwx11SubSequence_">remaining</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">LazySplitSequence</span> <span class="o">&lt;</span><span class="kt">Base</span><span class="p">:</span> <span class="kt">Collection</span><span class="o">&gt;</span><span class="p">:</span> <span class="kt">IteratorProtocol</span><span class="p">,</span> <span class="kt">LazySequenceProtocol</span> <span class="k">where</span>
<span class="kt">Base</span><span class="o">.</span><span class="kt">Iterator</span><span class="o">.</span><span class="kt">Element</span><span class="p">:</span> <span class="kt">Equatable</span><span class="p">,</span>
<span class="kt">Base</span><span class="o">.</span><span class="kt">SubSequence</span><span class="p">:</span> <span class="kt">Collection</span><span class="p">,</span>
<span class="kt">Base</span><span class="o">.</span><span class="kt">SubSequence</span><span class="o">.</span><span class="kt">Iterator</span><span class="o">.</span><span class="kt">Element</span><span class="o">==</span><span class="kt">Base</span><span class="o">.</span><span class="kt">Iterator</span><span class="o">.</span><span class="kt">Element</span><span class="p">,</span>
<span class="kt">Base</span><span class="o">.</span><span class="kt">SubSequence</span><span class="o">==</span><span class="kt">Base</span><span class="o">.</span><span class="kt">SubSequence</span><span class="o">.</span><span class="kt">SubSequence</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vV10SwiftShell17LazySplitSequence9separatorWx8Iterator7Element_"></a>
<a name="//apple_ref/swift/Property/separator" class="dashAnchor"></a>
<a class="token" href="#/s:vV10SwiftShell17LazySplitSequence9separatorWx8Iterator7Element_">separator</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">LazySplitSequence</span> <span class="o">&lt;</span><span class="kt">Base</span><span class="p">:</span> <span class="kt">Collection</span><span class="o">&gt;</span><span class="p">:</span> <span class="kt">IteratorProtocol</span><span class="p">,</span> <span class="kt">LazySequenceProtocol</span> <span class="k">where</span>
<span class="kt">Base</span><span class="o">.</span><span class="kt">Iterator</span><span class="o">.</span><span class="kt">Element</span><span class="p">:</span> <span class="kt">Equatable</span><span class="p">,</span>
<span class="kt">Base</span><span class="o">.</span><span class="kt">SubSequence</span><span class="p">:</span> <span class="kt">Collection</span><span class="p">,</span>
<span class="kt">Base</span><span class="o">.</span><span class="kt">SubSequence</span><span class="o">.</span><span class="kt">Iterator</span><span class="o">.</span><span class="kt">Element</span><span class="o">==</span><span class="kt">Base</span><span class="o">.</span><span class="kt">Iterator</span><span class="o">.</span><span class="kt">Element</span><span class="p">,</span>
<span class="kt">Base</span><span class="o">.</span><span class="kt">SubSequence</span><span class="o">==</span><span class="kt">Base</span><span class="o">.</span><span class="kt">SubSequence</span><span class="o">.</span><span class="kt">SubSequence</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vV10SwiftShell17LazySplitSequence16allowEmptySlicesSb"></a>
<a name="//apple_ref/swift/Property/allowEmptySlices" class="dashAnchor"></a>
<a class="token" href="#/s:vV10SwiftShell17LazySplitSequence16allowEmptySlicesSb">allowEmptySlices</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">LazySplitSequence</span> <span class="o">&lt;</span><span class="kt">Base</span><span class="p">:</span> <span class="kt">Collection</span><span class="o">&gt;</span><span class="p">:</span> <span class="kt">IteratorProtocol</span><span class="p">,</span> <span class="kt">LazySequenceProtocol</span> <span class="k">where</span>
<span class="kt">Base</span><span class="o">.</span><span class="kt">Iterator</span><span class="o">.</span><span class="kt">Element</span><span class="p">:</span> <span class="kt">Equatable</span><span class="p">,</span>
<span class="kt">Base</span><span class="o">.</span><span class="kt">SubSequence</span><span class="p">:</span> <span class="kt">Collection</span><span class="p">,</span>
<span class="kt">Base</span><span class="o">.</span><span class="kt">SubSequence</span><span class="o">.</span><span class="kt">Iterator</span><span class="o">.</span><span class="kt">Element</span><span class="o">==</span><span class="kt">Base</span><span class="o">.</span><span class="kt">Iterator</span><span class="o">.</span><span class="kt">Element</span><span class="p">,</span>
<span class="kt">Base</span><span class="o">.</span><span class="kt">SubSequence</span><span class="o">==</span><span class="kt">Base</span><span class="o">.</span><span class="kt">SubSequence</span><span class="o">.</span><span class="kt">SubSequence</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:FV10SwiftShell17LazySplitSequencecFTx9separatorWx8Iterator7Element_16allowEmptySlicesSb_GS0_x_"></a>
<a name="//apple_ref/swift/Method/init(_:separator:allowEmptySlices:)" class="dashAnchor"></a>
<a class="token" href="#/s:FV10SwiftShell17LazySplitSequencecFTx9separatorWx8Iterator7Element_16allowEmptySlicesSb_GS0_x_">init(_:separator:allowEmptySlices:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Creates a lazy sequence by splitting a Collection repeatedly.</p>
<ul>
<li>Parameters:
<ul>
<li>base: The Collection to split.</li>
<li>separator: The element of <code>base</code> to split over.</li>
<li>allowEmptySlices: If there are two or more separators in a row, or <code>base</code> begins or ends with
a separator, should empty slices be emitted? Defaults to false.</li>
</ul></li>
</ul>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="nf">init</span> <span class="p">(</span><span class="n">_</span> <span class="nv">base</span><span class="p">:</span> <span class="kt">Base</span><span class="p">,</span> <span class="nv">separator</span><span class="p">:</span> <span class="kt">Base</span><span class="o">.</span><span class="kt">Iterator</span><span class="o">.</span><span class="kt">Element</span><span class="p">,</span> <span class="nv">allowEmptySlices</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">false</span><span class="p">)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>base</em>
</code>
</td>
<td>
<div>
<p>The Collection to split.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>separator</em>
</code>
</td>
<td>
<div>
<p>The element of <code>base</code> to split over.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>allowEmptySlices</em>
</code>
</td>
<td>
<div>
<p>If there are two or more separators in a row, or <code>base</code> begins or ends with a separator, should empty slices be emitted? Defaults to false.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:FV10SwiftShell17LazySplitSequence4nextFT_GSqwx11SubSequence_"></a>
<a name="//apple_ref/swift/Method/next()" class="dashAnchor"></a>
<a class="token" href="#/s:FV10SwiftShell17LazySplitSequence4nextFT_GSqwx11SubSequence_">next()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The contents of base up to the next occurrence of separator.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">mutating</span> <span class="kd">func</span> <span class="nf">next</span> <span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">Base</span><span class="o">.</span><span class="kt">SubSequence</span><span class="p">?</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 2017 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2017-04-05)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</div>
</html>