1061 lines
63 KiB
HTML
1061 lines
63 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<title>Functions 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 title="Functions Reference"></a>
|
|
<header>
|
|
<div class="content-wrapper">
|
|
<p><a href="index.html"> Docs</a> (64% 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"> Reference</a>
|
|
<img id="carat" src="img/carat.png" />
|
|
Functions Reference
|
|
</p>
|
|
</div>
|
|
<div class="content-wrapper">
|
|
<nav class="sidebar">
|
|
<ul class="nav-groups">
|
|
<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:v10SwiftShell4FileCSo13NSFileManager">File</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Global Variables.html#/s:v10SwiftShell11environmentGVSs10DictionarySSSS_">environment</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Global Variables.html#/s:v10SwiftShell13standarderrorPS_19WriteableStreamType_">standarderror</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Global Variables.html#/s:v10SwiftShell13standardinputPS_18ReadableStreamType_">standardinput</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Global Variables.html#/s:v10SwiftShell14standardoutputPS_19WriteableStreamType_">standardoutput</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Global Variables.html#/s:v10SwiftShell14streamencodingSu">streamencoding</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Global Variables.html#/s:v10SwiftShell13tempdirectorySS">tempdirectory</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Global Variables.html#/s:v10SwiftShell13workdirectorySS">workdirectory</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/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:F10SwiftShell1$FSSSS">$(_:)</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Functions.html#/s:ZF10SwiftShelloi1dFTSSSS_SS">/(_:_:)</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Functions.html#/s:F10SwiftShell4dropUSs12SequenceType_Ss9Equatable_USs13GeneratorType__FGSaQ0__FT8sequenceQ__GVSs12LazySequenceGVSs18FilterSequenceViewQ___">drop(_:)</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Functions.html#/s:F10SwiftShell6filterUSs12SequenceType_USs13GeneratorType___FFQQQ_9Generator7ElementSbFT6sourceQ__GVSs12LazySequenceGVSs18FilterSequenceViewQ___">filter(_:)</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Functions.html#/s:F10SwiftShell4joinUSs24ExtensibleCollectionType_Ss12SequenceType_USs13GeneratorType__Ss16ForwardIndexType_Ss18_SignedIntegerType_Ss33_BuiltinIntegerLiteralConvertible___S2___FQ_FT8elementsQ0__Q_">join(_:)</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Functions.html#/s:F10SwiftShell3mapUSs12SequenceType__USs13GeneratorType___FFQQQ_9Generator7ElementQ0_FT6sourceQ__GVSs12LazySequenceGVSs15MapSequenceViewQ_Q0___">map(_:)</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Functions.html#/s:F10SwiftShell4openFSSPS_18ReadableStreamType_">open(_:)</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Functions.html#/s:F10SwiftShell4openFT10forWritingSS9overwriteSb_PS_19WriteableStreamType_">open(forWriting:overwrite:)</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Functions.html#/s:F10SwiftShell10parametersUSs12SequenceType_USs13GeneratorType___FQ_SS">parameters(_:)</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Functions.html#/s:F10SwiftShell17printErrorAndExitFSST_">printErrorAndExit(_:)</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Functions.html#/s:F10SwiftShell6reduceUSs12SequenceType__USs13GeneratorType___FTQ0_FTQ0_QQQ_9Generator7Element_Q0__FT8sequenceQ__Q0_">reduce(_:_:)</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Functions.html#/s:F10SwiftShell3runFSSPS_18ReadableStreamType_">run(_:)</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Functions.html#/s:F10SwiftShell6sortedUSs12SequenceType_USs13GeneratorType___FFTQQQ_9Generator7ElementS3__SbFT6sourceQ__GSaS3__">sorted(_:)</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Functions.html#/s:F10SwiftShell5splitFTSS_FT4textSS_GSaSS_">split(_:)</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Functions.html#/s:F10SwiftShell5splitFT9delimiterSS_FT6streamPS_18ReadableStreamType__GVSs10SequenceOfSS_">split(delimiter:)</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Functions.html#/s:F10SwiftShell6streamUSs12SequenceType_USs13GeneratorType__FQ_PS_18ReadableStreamType_">stream(_:)</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Functions.html#/s:F10SwiftShell6streamFSSPS_18ReadableStreamType_">stream(_:)</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Functions.html#/s:F10SwiftShell6streamFFT_FT_GSqSS_PS_18ReadableStreamType_">stream(_:)</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Functions.html#/s:F10SwiftShell7streamsFT_TPS_19WriteableStreamType_PS_18ReadableStreamType__">streams()</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Functions.html#/s:F10SwiftShell4takeUSs12SequenceType__USs13GeneratorType__FSiFT8sequenceQ__GSaQ0__">take(_:)</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Functions.html#/s:F10SwiftShell7toArrayUSs12SequenceType_USs13GeneratorType___FQ_GSaQQQ_9Generator7Element_">toArray(_:)</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Functions.html#/s:F10SwiftShell7writeToU__FPS_19WriteableStreamType_FT5inputQ__T_">writeTo(_:)</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Functions.html#/s:F10SwiftShell7writeToUSs12SequenceType_USs13GeneratorType___FPS_19WriteableStreamType_FT3seqQ__T_">writeTo(_:)</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Functions.html#/s:F10SwiftShell7writeToFPS_19WriteableStreamType_FT5inputSS_T_">writeTo(_:)</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Functions.html#/s:ZF10SwiftShelloi2ogFTPS_18ReadableStreamType_KT_PS0___PS0__">|>(_:_:)</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Functions.html#/s:ZF10SwiftShelloi2ogU___FTQ_FQ_Q0__Q0_">|>(_:_:)</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Functions.html#/s:ZF10SwiftShelloi3oggFTSSPS_19WriteableStreamType__T_">|>>(_:_:)</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Functions.html#/s:ZF10SwiftShelloi3oggU__FTQ_PS_19WriteableStreamType__T_">|>>(_:_:)</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Functions.html#/s:ZF10SwiftShelloi3oggUSs12SequenceType_USs13GeneratorType___FTQ_PS_19WriteableStreamType__T_">|>>(_:_:)</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/ReadableStreamType.html">ReadableStreamType</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="Protocols/WriteableStreamType.html">WriteableStreamType</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<article class="main-content">
|
|
<section>
|
|
<section class="section">
|
|
<h1>Functions</h1>
|
|
<p>The following functions are available globally.</p>
|
|
|
|
</section>
|
|
<section class="section task-group-section">
|
|
<div class="task-group">
|
|
<ul>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:ZF10SwiftShelloi2ogU___FTQ_FQ_Q0__Q0_"></a>
|
|
<a name="//apple_ref/swift/Function/|>(_:_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:ZF10SwiftShelloi2ogU___FTQ_FQ_Q0__Q0_">|>(_:_:)</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>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:F10SwiftShell6filterUSs12SequenceType_USs13GeneratorType___FFQQQ_9Generator7ElementSbFT6sourceQ__GVSs12LazySequenceGVSs18FilterSequenceViewQ___"></a>
|
|
<a name="//apple_ref/swift/Function/filter(_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:F10SwiftShell6filterUSs12SequenceType_USs13GeneratorType___FFQQQ_9Generator7ElementSbFT6sourceQ__GVSs12LazySequenceGVSs18FilterSequenceViewQ___">filter(_:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Lazily return a sequence containing the elements of source, in order, that satisfy the predicate includeElement</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="Swift">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="n">filter</span> <span class="o"><</span><span class="kt">S</span> <span class="p">:</span> <span class="kt">SequenceType</span><span class="o">></span>
|
|
<span class="p">(</span><span class="nv">includeElement</span><span class="p">:</span> <span class="p">(</span><span class="kt">S</span><span class="o">.</span><span class="kt">Generator</span><span class="o">.</span><span class="kt">Element</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Bool</span><span class="p">)</span>
|
|
<span class="p">(</span><span class="nv">source</span><span class="p">:</span> <span class="kt">S</span><span class="p">)</span>
|
|
<span class="o">-></span> <span class="kt">LazySequence</span><span class="o"><</span><span class="kt">FilterSequenceView</span><span class="o"><</span><span class="kt">S</span><span class="o">>></span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:F10SwiftShell6sortedUSs12SequenceType_USs13GeneratorType___FFTQQQ_9Generator7ElementS3__SbFT6sourceQ__GSaS3__"></a>
|
|
<a name="//apple_ref/swift/Function/sorted(_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:F10SwiftShell6sortedUSs12SequenceType_USs13GeneratorType___FFTQQQ_9Generator7ElementS3__SbFT6sourceQ__GSaS3__">sorted(_:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Return an <code>Array</code> containing the sorted elements of <code>source</code> according to ‘isOrderedBefore’.</p>
|
|
|
|
<p>Requires: <code>isOrderedBefore</code> is a <code>strict weak ordering
|
|
<http://en.wikipedia.org/wiki/Strict_weak_order#Strict_weak_orderings></code> over <code>elements</code>.</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="Swift">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="n">sorted</span> <span class="o"><</span><span class="kt">S</span> <span class="p">:</span> <span class="kt">SequenceType</span><span class="o">></span>
|
|
<span class="p">(</span><span class="nv">isOrderedBefore</span><span class="p">:</span> <span class="p">(</span><span class="kt">S</span><span class="o">.</span><span class="kt">Generator</span><span class="o">.</span><span class="kt">Element</span><span class="p">,</span> <span class="kt">S</span><span class="o">.</span><span class="kt">Generator</span><span class="o">.</span><span class="kt">Element</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Bool</span><span class="p">)</span>
|
|
<span class="p">(</span><span class="nv">source</span><span class="p">:</span> <span class="kt">S</span><span class="p">)</span>
|
|
<span class="o">-></span> <span class="p">[</span><span class="kt">S</span><span class="o">.</span><span class="kt">Generator</span><span class="o">.</span><span class="kt">Element</span><span class="p">]</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:F10SwiftShell3mapUSs12SequenceType__USs13GeneratorType___FFQQQ_9Generator7ElementQ0_FT6sourceQ__GVSs12LazySequenceGVSs15MapSequenceViewQ_Q0___"></a>
|
|
<a name="//apple_ref/swift/Function/map(_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:F10SwiftShell3mapUSs12SequenceType__USs13GeneratorType___FFQQQ_9Generator7ElementQ0_FT6sourceQ__GVSs12LazySequenceGVSs15MapSequenceViewQ_Q0___">map(_:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Lazily return a sequence containing the results of mapping transform over source.</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="Swift">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="n">map</span> <span class="o"><</span><span class="kt">S</span><span class="p">:</span> <span class="kt">SequenceType</span><span class="p">,</span> <span class="kt">T</span><span class="o">></span>
|
|
<span class="p">(</span><span class="nv">transform</span><span class="p">:</span> <span class="p">(</span><span class="kt">S</span><span class="o">.</span><span class="kt">Generator</span><span class="o">.</span><span class="kt">Element</span><span class="p">)</span> <span class="o">-></span> <span class="kt">T</span><span class="p">)</span>
|
|
<span class="p">(</span><span class="nv">source</span><span class="p">:</span> <span class="kt">S</span><span class="p">)</span>
|
|
<span class="o">-></span> <span class="kt">LazySequence</span><span class="o"><</span><span class="kt">MapSequenceView</span><span class="o"><</span><span class="kt">S</span><span class="p">,</span> <span class="kt">T</span><span class="o">>></span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:F10SwiftShell6reduceUSs12SequenceType__USs13GeneratorType___FTQ0_FTQ0_QQQ_9Generator7Element_Q0__FT8sequenceQ__Q0_"></a>
|
|
<a name="//apple_ref/swift/Function/reduce(_:_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:F10SwiftShell6reduceUSs12SequenceType__USs13GeneratorType___FTQ0_FTQ0_QQQ_9Generator7Element_Q0__FT8sequenceQ__Q0_">reduce(_:_:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Return the result of repeatedly calling combine with an accumulated value
|
|
initialized to initial and each element of sequence, in turn.</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="Swift">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="n">reduce</span> <span class="o"><</span><span class="kt">S</span> <span class="p">:</span> <span class="kt">SequenceType</span><span class="p">,</span> <span class="kt">U</span><span class="o">></span>
|
|
<span class="p">(</span><span class="nv">initial</span><span class="p">:</span> <span class="kt">U</span><span class="p">,</span> <span class="nv">combine</span><span class="p">:</span> <span class="p">(</span><span class="kt">U</span><span class="p">,</span> <span class="kt">S</span><span class="o">.</span><span class="kt">Generator</span><span class="o">.</span><span class="kt">Element</span><span class="p">)</span> <span class="o">-></span> <span class="kt">U</span><span class="p">)</span>
|
|
<span class="p">(</span><span class="nv">sequence</span><span class="p">:</span> <span class="kt">S</span><span class="p">)</span>
|
|
<span class="o">-></span> <span class="kt">U</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:F10SwiftShell5splitFTSS_FT4textSS_GSaSS_"></a>
|
|
<a name="//apple_ref/swift/Function/split(_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:F10SwiftShell5splitFTSS_FT4textSS_GSaSS_">split(_:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Split text over delimiter, returning an array.</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="Swift">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">split</span> <span class="p">(</span><span class="n">_</span> <span class="nv">delimiter</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">)(</span><span class="nv">text</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="p">[</span><span class="kt">String</span><span class="p">]</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:F10SwiftShell4joinUSs24ExtensibleCollectionType_Ss12SequenceType_USs13GeneratorType__Ss16ForwardIndexType_Ss18_SignedIntegerType_Ss33_BuiltinIntegerLiteralConvertible___S2___FQ_FT8elementsQ0__Q_"></a>
|
|
<a name="//apple_ref/swift/Function/join(_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:F10SwiftShell4joinUSs24ExtensibleCollectionType_Ss12SequenceType_USs13GeneratorType__Ss16ForwardIndexType_Ss18_SignedIntegerType_Ss33_BuiltinIntegerLiteralConvertible___S2___FQ_FT8elementsQ0__Q_">join(_:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Insert separator between each item in elements.</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="Swift">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="n">join</span> <span class="o"><</span><span class="kt">C</span> <span class="p">:</span> <span class="kt">ExtensibleCollectionType</span><span class="p">,</span> <span class="kt">S</span> <span class="p">:</span> <span class="kt">SequenceType</span> <span class="k">where</span> <span class="kt">S</span><span class="o">.</span><span class="kt">Generator</span><span class="o">.</span><span class="kt">Element</span> <span class="o">==</span> <span class="kt">C</span><span class="o">></span>
|
|
<span class="p">(</span><span class="nv">separator</span><span class="p">:</span> <span class="kt">C</span><span class="p">)</span>
|
|
<span class="p">(</span><span class="nv">elements</span><span class="p">:</span> <span class="kt">S</span><span class="p">)</span>
|
|
<span class="o">-></span> <span class="kt">C</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:F10SwiftShell7toArrayUSs12SequenceType_USs13GeneratorType___FQ_GSaQQQ_9Generator7Element_"></a>
|
|
<a name="//apple_ref/swift/Function/toArray(_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:F10SwiftShell7toArrayUSs12SequenceType_USs13GeneratorType___FQ_GSaQQQ_9Generator7Element_">toArray(_:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Turn a sequence into an array. For use after the |> operator.</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="Swift">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="n">toArray</span> <span class="o"><</span><span class="kt">S</span> <span class="p">:</span> <span class="kt">SequenceType</span><span class="o">></span> <span class="p">(</span><span class="nv">sequence</span><span class="p">:</span> <span class="kt">S</span><span class="p">)</span> <span class="o">-></span> <span class="p">[</span><span class="kt">S</span><span class="o">.</span><span class="kt">Generator</span><span class="o">.</span><span class="kt">Element</span><span class="p">]</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:F10SwiftShell4dropUSs12SequenceType_Ss9Equatable_USs13GeneratorType__FGSaQ0__FT8sequenceQ__GVSs12LazySequenceGVSs18FilterSequenceViewQ___"></a>
|
|
<a name="//apple_ref/swift/Function/drop(_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:F10SwiftShell4dropUSs12SequenceType_Ss9Equatable_USs13GeneratorType__FGSaQ0__FT8sequenceQ__GVSs12LazySequenceGVSs18FilterSequenceViewQ___">drop(_:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Discard all elements in <code>tobedropped</code> from sequence.</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="Swift">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="n">drop</span> <span class="o"><</span><span class="kt">S</span> <span class="p">:</span> <span class="kt">SequenceType</span><span class="p">,</span> <span class="kt">T</span> <span class="p">:</span> <span class="kt">Equatable</span> <span class="k">where</span> <span class="kt">S</span><span class="o">.</span><span class="kt">Generator</span><span class="o">.</span><span class="kt">Element</span> <span class="o">==</span> <span class="kt">T</span><span class="o">></span>
|
|
<span class="p">(</span><span class="nv">tobedropped</span><span class="p">:</span> <span class="p">[</span><span class="kt">T</span><span class="p">])</span>
|
|
<span class="p">(</span><span class="nv">sequence</span><span class="p">:</span> <span class="kt">S</span><span class="p">)</span>
|
|
<span class="o">-></span> <span class="kt">LazySequence</span><span class="o"><</span><span class="kt">FilterSequenceView</span><span class="o"><</span><span class="kt">S</span><span class="o">>></span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:F10SwiftShell4takeUSs12SequenceType__USs13GeneratorType__FSiFT8sequenceQ__GSaQ0__"></a>
|
|
<a name="//apple_ref/swift/Function/take(_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:F10SwiftShell4takeUSs12SequenceType__USs13GeneratorType__FSiFT8sequenceQ__GSaQ0__">take(_:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Return at most the first <code>numbertotake</code> elements of sequence</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="Swift">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="n">take</span> <span class="o"><</span><span class="kt">S</span> <span class="p">:</span> <span class="kt">SequenceType</span><span class="p">,</span> <span class="kt">T</span> <span class="k">where</span> <span class="kt">S</span><span class="o">.</span><span class="kt">Generator</span><span class="o">.</span><span class="kt">Element</span> <span class="o">==</span> <span class="kt">T</span><span class="o">></span>
|
|
<span class="p">(</span><span class="nv">numbertotake</span><span class="p">:</span> <span class="kt">Int</span><span class="p">)(</span><span class="nv">sequence</span><span class="p">:</span> <span class="kt">S</span><span class="p">)</span> <span class="o">-></span> <span class="p">[</span><span class="kt">T</span><span class="p">]</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="task-group">
|
|
<ul>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:F10SwiftShell17printErrorAndExitFSST_"></a>
|
|
<a name="//apple_ref/swift/Function/printErrorAndExit(_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:F10SwiftShell17printErrorAndExitFSST_">printErrorAndExit(_:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Print message to standard error and halt execution.</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="Swift">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="k">@noreturn</span> <span class="kd">public</span> <span class="kd">func</span> <span class="nf">printErrorAndExit</span> <span class="p">(</span><span class="nv">errormessage</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:F10SwiftShell4openFSSPS_18ReadableStreamType_"></a>
|
|
<a name="//apple_ref/swift/Function/open(_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:F10SwiftShell4openFSSPS_18ReadableStreamType_">open(_:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Open a file for reading, and exit if an error occurs.</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="Swift">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">open</span> <span class="p">(</span><span class="nv">path</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">ReadableStreamType</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:F10SwiftShell4openFT10forWritingSS9overwriteSb_PS_19WriteableStreamType_"></a>
|
|
<a name="//apple_ref/swift/Function/open(forWriting:overwrite:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:F10SwiftShell4openFT10forWritingSS9overwriteSb_PS_19WriteableStreamType_">open(forWriting:overwrite:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Open a file for writing, create it if it doesn’t exist, and exit if an error occurs.
|
|
If the file already exists and overwrite=false, the writing will begin at the end of the file.</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="Swift">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">open</span> <span class="p">(</span><span class="n">forWriting</span> <span class="nv">path</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">overwrite</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">false</span><span class="p">)</span> <span class="o">-></span> <span class="kt">WriteableStreamType</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h4>Parameters</h4>
|
|
<table class="graybox">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>overwrite</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>If true, replace the file if it exists.</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="task-group">
|
|
<ul>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:F10SwiftShell6streamFSSPS_18ReadableStreamType_"></a>
|
|
<a name="//apple_ref/swift/Function/stream(_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:F10SwiftShell6streamFSSPS_18ReadableStreamType_">stream(_:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Create a stream from a String.</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="Swift">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">stream</span> <span class="p">(</span><span class="nv">text</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">ReadableStreamType</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:F10SwiftShell6streamFFT_FT_GSqSS_PS_18ReadableStreamType_"></a>
|
|
<a name="//apple_ref/swift/Function/stream(_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:F10SwiftShell6streamFFT_FT_GSqSS_PS_18ReadableStreamType_">stream(_:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Create a stream from a function returning a generator function, which is called every time the stream is asked for more text.</p>
|
|
|
|
<p>stream {
|
|
// initialisation…
|
|
return {
|
|
// called repeatedly by the resulting stream
|
|
// return text, or return nil when done.
|
|
}
|
|
}</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="Swift">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">stream</span> <span class="p">(</span> <span class="nv">closure</span><span class="p">:()</span> <span class="o">-></span> <span class="p">()</span> <span class="o">-></span> <span class="kt">String</span><span class="p">?</span> <span class="p">)</span> <span class="o">-></span> <span class="kt">ReadableStreamType</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h4>Return Value</h4>
|
|
<p>The output stream.</p>
|
|
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:F10SwiftShell6streamUSs12SequenceType_USs13GeneratorType__FQ_PS_18ReadableStreamType_"></a>
|
|
<a name="//apple_ref/swift/Function/stream(_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:F10SwiftShell6streamUSs12SequenceType_USs13GeneratorType__FQ_PS_18ReadableStreamType_">stream(_:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Create a stream from a sequence of Strings.</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="Swift">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="n">stream</span> <span class="o"><</span><span class="kt">Seq</span> <span class="p">:</span> <span class="kt">SequenceType</span> <span class="k">where</span> <span class="kt">Seq</span><span class="o">.</span><span class="kt">Generator</span><span class="o">.</span><span class="kt">Element</span> <span class="o">==</span> <span class="kt">String</span><span class="o">></span> <span class="p">(</span><span class="nv">sequence</span><span class="p">:</span> <span class="kt">Seq</span><span class="p">)</span> <span class="o">-></span> <span class="kt">ReadableStreamType</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:F10SwiftShell7streamsFT_TPS_19WriteableStreamType_PS_18ReadableStreamType__"></a>
|
|
<a name="//apple_ref/swift/Function/streams()" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:F10SwiftShell7streamsFT_TPS_19WriteableStreamType_PS_18ReadableStreamType__">streams()</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Return a writable stream and a readable stream. What you write to the 1st one can be read from the 2nd one.
|
|
Make sure to call closeStream() on the writable stream before you call read() on the readable one.</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="Swift">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">streams</span> <span class="p">()</span> <span class="o">-></span> <span class="p">(</span><span class="kt">WriteableStreamType</span><span class="p">,</span> <span class="kt">ReadableStreamType</span><span class="p">)</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:F10SwiftShell5splitFT9delimiterSS_FT6streamPS_18ReadableStreamType__GVSs10SequenceOfSS_"></a>
|
|
<a name="//apple_ref/swift/Function/split(delimiter:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:F10SwiftShell5splitFT9delimiterSS_FT6streamPS_18ReadableStreamType__GVSs10SequenceOfSS_">split(delimiter:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Split a stream lazily</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="Swift">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">split</span> <span class="p">(</span><span class="nv">delimiter</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">)(</span><span class="nv">stream</span><span class="p">:</span> <span class="kt">ReadableStreamType</span><span class="p">)</span> <span class="o">-></span> <span class="kt">SequenceOf</span><span class="o"><</span><span class="kt">String</span><span class="o">></span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:F10SwiftShell7writeToU__FPS_19WriteableStreamType_FT5inputQ__T_"></a>
|
|
<a name="//apple_ref/swift/Function/writeTo(_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:F10SwiftShell7writeToU__FPS_19WriteableStreamType_FT5inputQ__T_">writeTo(_:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Write something to a stream.</p>
|
|
|
|
<pre class="highlight plaintext"><code>something |> writeTo(writablestream)
|
|
</code></pre>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="Swift">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="n">writeTo</span> <span class="o"><</span><span class="kt">T</span><span class="o">></span> <span class="p">(</span><span class="nv">stream</span><span class="p">:</span> <span class="kt">WriteableStreamType</span><span class="p">)(</span><span class="nv">input</span><span class="p">:</span> <span class="kt">T</span><span class="p">)</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:F10SwiftShell7writeToFPS_19WriteableStreamType_FT5inputSS_T_"></a>
|
|
<a name="//apple_ref/swift/Function/writeTo(_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:F10SwiftShell7writeToFPS_19WriteableStreamType_FT5inputSS_T_">writeTo(_:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Write a String to a writable stream.</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="Swift">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">writeTo</span> <span class="p">(</span><span class="nv">stream</span><span class="p">:</span> <span class="kt">WriteableStreamType</span><span class="p">)(</span><span class="nv">input</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:F10SwiftShell7writeToUSs12SequenceType_USs13GeneratorType___FPS_19WriteableStreamType_FT3seqQ__T_"></a>
|
|
<a name="//apple_ref/swift/Function/writeTo(_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:F10SwiftShell7writeToUSs12SequenceType_USs13GeneratorType___FPS_19WriteableStreamType_FT3seqQ__T_">writeTo(_:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Write a sequence to a stream.</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="Swift">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="n">writeTo</span> <span class="o"><</span><span class="kt">S</span> <span class="p">:</span> <span class="kt">SequenceType</span><span class="o">></span> <span class="p">(</span><span class="nv">stream</span><span class="p">:</span> <span class="kt">WriteableStreamType</span><span class="p">)(</span><span class="nv">seq</span><span class="p">:</span> <span class="kt">S</span><span class="p">)</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:ZF10SwiftShelloi3oggU__FTQ_PS_19WriteableStreamType__T_"></a>
|
|
<a name="//apple_ref/swift/Function/|>>(_:_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:ZF10SwiftShelloi3oggU__FTQ_PS_19WriteableStreamType__T_">|>>(_:_:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Write something to a stream.</p>
|
|
|
|
<p>something |>> writablestream</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="Swift">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="o">|>></span> <span class="o"><</span><span class="kt">T</span><span class="o">></span> <span class="p">(</span><span class="nv">input</span><span class="p">:</span> <span class="kt">T</span><span class="p">,</span> <span class="nv">stream</span><span class="p">:</span> <span class="kt">WriteableStreamType</span><span class="p">)</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:ZF10SwiftShelloi3oggFTSSPS_19WriteableStreamType__T_"></a>
|
|
<a name="//apple_ref/swift/Function/|>>(_:_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:ZF10SwiftShelloi3oggFTSSPS_19WriteableStreamType__T_">|>>(_:_:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Write a String to a writable stream.</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="Swift">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="o">|>></span> <span class="p">(</span><span class="nv">text</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">stream</span><span class="p">:</span> <span class="kt">WriteableStreamType</span><span class="p">)</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:ZF10SwiftShelloi3oggUSs12SequenceType_USs13GeneratorType___FTQ_PS_19WriteableStreamType__T_"></a>
|
|
<a name="//apple_ref/swift/Function/|>>(_:_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:ZF10SwiftShelloi3oggUSs12SequenceType_USs13GeneratorType___FTQ_PS_19WriteableStreamType__T_">|>>(_:_:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Write a sequence to a stream.</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="Swift">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="o">|>></span> <span class="o"><</span><span class="kt">S</span> <span class="p">:</span> <span class="kt">SequenceType</span><span class="o">></span> <span class="p">(</span><span class="nv">seq</span><span class="p">:</span> <span class="kt">S</span><span class="p">,</span> <span class="nv">stream</span><span class="p">:</span> <span class="kt">WriteableStreamType</span><span class="p">)</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="task-group">
|
|
<ul>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:ZF10SwiftShelloi2ogFTPS_18ReadableStreamType_KT_PS0___PS0__"></a>
|
|
<a name="//apple_ref/swift/Function/|>(_:_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:ZF10SwiftShelloi2ogFTPS_18ReadableStreamType_KT_PS0___PS0__">|>(_:_:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Specific handling of func run (shellcommand: String) -> ReadableStreamType on the right side using the stream on the
|
|
left side as standard input.</p>
|
|
|
|
<p>Warning: is only meant to be used with the <q>run</q> command, but could also unintentionally catch other uses of
|
|
<q>ReadableStreamType |> ReadableStreamType</q>, though that statement doesn’t make any sense.</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="Swift">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="o">|></span> <span class="p">(</span><span class="nv">lhs</span><span class="p">:</span> <span class="kt">ReadableStreamType</span><span class="p">,</span> <span class="k">@autoclosure</span> <span class="nv">rhs</span><span class="p">:</span> <span class="p">()</span> <span class="o">-></span> <span class="kt">ReadableStreamType</span><span class="p">)</span> <span class="o">-></span> <span class="kt">ReadableStreamType</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:F10SwiftShell3runFSSPS_18ReadableStreamType_"></a>
|
|
<a name="//apple_ref/swift/Function/run(_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:F10SwiftShell3runFSSPS_18ReadableStreamType_">run(_:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Run a shell command synchronously with no standard input,
|
|
or if to the right of a <q>ReadableStreamType |></q>, use the stream on the left side as standard input.</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="Swift">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">run</span> <span class="p">(</span><span class="nv">shellcommand</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">ReadableStreamType</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h4>Return Value</h4>
|
|
<p>Standard output</p>
|
|
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:F10SwiftShell1$FSSSS"></a>
|
|
<a name="//apple_ref/swift/Function/$(_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:F10SwiftShell1$FSSSS">$(_:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Shortcut for in-line command, returns output as String.</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="Swift">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="err">$</span> <span class="p">(</span><span class="nv">shellcommand</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">String</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:F10SwiftShell10parametersUSs12SequenceType_USs13GeneratorType___FQ_SS"></a>
|
|
<a name="//apple_ref/swift/Function/parameters(_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:F10SwiftShell10parametersUSs12SequenceType_USs13GeneratorType___FQ_SS">parameters(_:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Turn a sequence into valid parameters for a shell command, properly quoted</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="Swift">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="n">parameters</span> <span class="o"><</span><span class="kt">S</span> <span class="p">:</span> <span class="kt">SequenceType</span><span class="o">></span> <span class="p">(</span><span class="nv">sequence</span><span class="p">:</span> <span class="kt">S</span><span class="p">)</span> <span class="o">-></span> <span class="kt">String</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="task-group">
|
|
<ul>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:ZF10SwiftShelloi1dFTSSSS_SS"></a>
|
|
<a name="//apple_ref/swift/Function//(_:_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:ZF10SwiftShelloi1dFTSSSS_SS">/(_:_:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Allows for <code>"/directory" / "file.extension"</code> etc.</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="Swift">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="o">/</span> <span class="p">(</span><span class="nv">leftpath</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">rightpath</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">String</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section id="footer">
|
|
<p>© 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-05-19)</p>
|
|
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.2.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
|
</section>
|
|
</article>
|
|
</div>
|
|
</body>
|
|
</div>
|
|
</html>
|