New documentation generated by https://github.com/realm/jazzy.

Specifically

	jazzy -o ../Docs -g https://github.com/kareman/SwiftShell
This commit is contained in:
Kare Morstol
2015-05-19 19:34:08 +02:00
parent fc77c78567
commit 5b6359d5fd
37 changed files with 8200 additions and 0 deletions
+247
View File
@@ -0,0 +1,247 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>Extensions 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="Extensions 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" />
Extensions 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__">|&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:ZF10SwiftShelloi2ogU___FTQ_FQ_Q0__Q0_">|&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:ZF10SwiftShelloi3oggFTSSPS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:ZF10SwiftShelloi3oggU__FTQ_PS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:ZF10SwiftShelloi3oggUSs12SequenceType_USs13GeneratorType___FTQ_PS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</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>Extensions</h1>
<p>The following extensions are available globally.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:SS"></a>
<a name="//apple_ref/swift/Extension/String" class="dashAnchor"></a>
<a class="token" href="#/s:SS">String</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<a href="Extensions/String.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">struct</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:10SwiftShell10FileHandle"></a>
<a name="//apple_ref/swift/Extension/FileHandle" class="dashAnchor"></a>
<a class="token" href="#/s:10SwiftShell10FileHandle">FileHandle</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>
<a href="Extensions/FileHandle.html" class="slightly-smaller">See more</a>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 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>
+353
View File
@@ -0,0 +1,353 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>FileHandle Extension 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/Extension/FileHandle" class="dashAnchor"></a>
<a title="FileHandle Extension 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" />
FileHandle Extension 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__">|&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:ZF10SwiftShelloi2ogU___FTQ_FQ_Q0__Q0_">|&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:ZF10SwiftShelloi3oggFTSSPS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:ZF10SwiftShelloi3oggU__FTQ_PS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:ZF10SwiftShelloi3oggUSs12SequenceType_USs13GeneratorType___FTQ_PS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</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>FileHandle</h1>
<p>Undocumented</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:FE10SwiftShellCSo12NSFileHandle8readSomeFS0_FT_GSqSS_"></a>
<a name="//apple_ref/swift/Method/readSome()" class="dashAnchor"></a>
<a class="token" href="#/s:FE10SwiftShellCSo12NSFileHandle8readSomeFS0_FT_GSqSS_">readSome()</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:FE10SwiftShellCSo12NSFileHandle4readFS0_FT_SS"></a>
<a name="//apple_ref/swift/Method/read()" class="dashAnchor"></a>
<a class="token" href="#/s:FE10SwiftShellCSo12NSFileHandle4readFS0_FT_SS">read()</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:FE10SwiftShellCSo12NSFileHandle5linesFS0_FT_GVSs10SequenceOfSS_"></a>
<a name="//apple_ref/swift/Method/lines()" class="dashAnchor"></a>
<a class="token" href="#/s:FE10SwiftShellCSo12NSFileHandle5linesFS0_FT_GVSs10SequenceOfSS_">lines()</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:FE10SwiftShellCSo12NSFileHandle7writeToFS0_USs16OutputStreamType__FRQ_T_"></a>
<a name="//apple_ref/swift/Method/writeTo(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:FE10SwiftShellCSo12NSFileHandle7writeToFS0_USs16OutputStreamType__FRQ_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>Undocumented</p>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:FE10SwiftShellCSo12NSFileHandle5writeFS0_FSST_"></a>
<a name="//apple_ref/swift/Method/write(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:FE10SwiftShellCSo12NSFileHandle5writeFS0_FSST_">write(_:)</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:FE10SwiftShellCSo12NSFileHandle7writelnFS0_FSST_"></a>
<a name="//apple_ref/swift/Method/writeln(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:FE10SwiftShellCSo12NSFileHandle7writelnFS0_FSST_">writeln(_:)</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:FE10SwiftShellCSo12NSFileHandle7writelnFS0_FT_T_"></a>
<a name="//apple_ref/swift/Method/writeln()" class="dashAnchor"></a>
<a class="token" href="#/s:FE10SwiftShellCSo12NSFileHandle7writelnFS0_FT_T_">writeln()</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:FE10SwiftShellCSo12NSFileHandle11closeStreamFS0_FT_T_"></a>
<a name="//apple_ref/swift/Method/closeStream()" class="dashAnchor"></a>
<a class="token" href="#/s:FE10SwiftShellCSo12NSFileHandle11closeStreamFS0_FT_T_">closeStream()</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>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 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>
+355
View File
@@ -0,0 +1,355 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>String Extension 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/Extension/String" class="dashAnchor"></a>
<a title="String Extension 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" />
String Extension 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__">|&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:ZF10SwiftShelloi2ogU___FTQ_FQ_Q0__Q0_">|&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:ZF10SwiftShelloi3oggFTSSPS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:ZF10SwiftShelloi3oggU__FTQ_PS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:ZF10SwiftShelloi3oggUSs12SequenceType_USs13GeneratorType___FTQ_PS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</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>String</h1>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:FE10SwiftShellSS7replaceFSSFTSSSS_SS"></a>
<a name="//apple_ref/swift/Method/replace(_:_:)" class="dashAnchor"></a>
<a class="token" href="#/s:FE10SwiftShellSS7replaceFSSFTSSSS_SS">replace(_:_:)</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:FE10SwiftShellSS7replaceFSSFTSSSS5limitSi_SS"></a>
<a name="//apple_ref/swift/Method/replace(_:_:limit:)" class="dashAnchor"></a>
<a class="token" href="#/s:FE10SwiftShellSS7replaceFSSFTSSSS5limitSi_SS">replace(_:_:limit:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Replace the first <code>limit</code> occurrences of oldString with newString.</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">replace</span> <span class="p">(</span><span class="nv">oldString</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="n">_</span> <span class="nv">newString</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">limit</span><span class="p">:</span> <span class="kt">Int</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">String</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:FE10SwiftShellSS5splitFSSFSSGSaSS_"></a>
<a name="//apple_ref/swift/Method/split(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:FE10SwiftShellSS5splitFSSFSSGSaSS_">split(_:)</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:FE10SwiftShellSS4trimFSSFT_SS"></a>
<a name="//apple_ref/swift/Method/trim()" class="dashAnchor"></a>
<a class="token" href="#/s:FE10SwiftShellSS4trimFSSFT_SS">trim()</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:FE10SwiftShellSS18countOccurrencesOfFSSFSSSi"></a>
<a name="//apple_ref/swift/Method/countOccurrencesOf(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:FE10SwiftShellSS18countOccurrencesOfFSSFSSSi">countOccurrencesOf(_:)</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:FE10SwiftShellSS7findAllFSSFSSGVSs10SequenceOfGVSs5RangeVSS5Index__"></a>
<a name="//apple_ref/swift/Method/findAll(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:FE10SwiftShellSS7findAllFSSFSSGVSs10SequenceOfGVSs5RangeVSS5Index__">findAll(_:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>A lazy sequence of the ranges of <code>findstring</code> in this 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">findAll</span> <span class="p">(</span><span class="nv">findstring</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">SequenceOf</span><span class="o">&lt;</span><span class="kt">Range</span><span class="o">&lt;</span><span class="kt">String</span><span class="o">.</span><span class="kt">Index</span><span class="o">&gt;&gt;</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:FE10SwiftShellSS9partitionFSSFSSTSSSSSS_"></a>
<a name="//apple_ref/swift/Method/partition(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:FE10SwiftShellSS9partitionFSSFSSTSSSSSS_">partition(_:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Split the string at the first occurrence of separator, and return a 3-tuple containing the part
before the separator, the separator itself, and the part after the separator. If the separator is
not found, return a 3-tuple containing the string itself, followed by two empty 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="nf">partition</span> <span class="p">(</span><span class="nv">separator</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="p">(</span><span class="kt">String</span><span class="p">,</span> <span class="kt">String</span><span class="p">,</span> <span class="kt">String</span><span class="p">)</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 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>
+1060
View File
File diff suppressed because it is too large Load Diff
+386
View File
@@ -0,0 +1,386 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>Global Variables 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="Global Variables 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" />
Global Variables 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__">|&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:ZF10SwiftShelloi2ogU___FTQ_FQ_Q0__Q0_">|&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:ZF10SwiftShelloi3oggFTSSPS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:ZF10SwiftShelloi3oggU__FTQ_PS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:ZF10SwiftShelloi3oggUSs12SequenceType_USs13GeneratorType___FTQ_PS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</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>Global Variables</h1>
<p>The following global variables are available globally.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:v10SwiftShell11environmentGVSs10DictionarySSSS_"></a>
<a name="//apple_ref/swift/Global/environment" class="dashAnchor"></a>
<a class="token" href="#/s:v10SwiftShell11environmentGVSs10DictionarySSSS_">environment</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:v10SwiftShell13standardinputPS_18ReadableStreamType_"></a>
<a name="//apple_ref/swift/Global/standardinput" class="dashAnchor"></a>
<a class="token" href="#/s:v10SwiftShell13standardinputPS_18ReadableStreamType_">standardinput</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:v10SwiftShell14standardoutputPS_19WriteableStreamType_"></a>
<a name="//apple_ref/swift/Global/standardoutput" class="dashAnchor"></a>
<a class="token" href="#/s:v10SwiftShell14standardoutputPS_19WriteableStreamType_">standardoutput</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:v10SwiftShell13standarderrorPS_19WriteableStreamType_"></a>
<a name="//apple_ref/swift/Global/standarderror" class="dashAnchor"></a>
<a class="token" href="#/s:v10SwiftShell13standarderrorPS_19WriteableStreamType_">standarderror</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>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:v10SwiftShell14streamencodingSu"></a>
<a name="//apple_ref/swift/Global/streamencoding" class="dashAnchor"></a>
<a class="token" href="#/s:v10SwiftShell14streamencodingSu">streamencoding</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>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:v10SwiftShell4FileCSo13NSFileManager"></a>
<a name="//apple_ref/swift/Global/File" class="dashAnchor"></a>
<a class="token" href="#/s:v10SwiftShell4FileCSo13NSFileManager">File</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The default NSFileManager</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="k">let</span> <span class="nv">File</span> <span class="o">=</span> <span class="kt">NSFileManager</span><span class="o">.</span><span class="nf">defaultManager</span><span class="p">()</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:v10SwiftShell13tempdirectorySS"></a>
<a name="//apple_ref/swift/Global/tempdirectory" class="dashAnchor"></a>
<a class="token" href="#/s:v10SwiftShell13tempdirectorySS">tempdirectory</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The tempdirectory is unique each time a script is run and is created the first time it is used.
It lies in the user&rsquo;s temporary directory and will be automatically deleted at some point.</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="k">let</span> <span class="nv">tempdirectory</span><span class="p">:</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:v10SwiftShell13workdirectorySS"></a>
<a name="//apple_ref/swift/Global/workdirectory" class="dashAnchor"></a>
<a class="token" href="#/s:v10SwiftShell13workdirectorySS">workdirectory</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The current working directory.</p>
<p>Must be used instead of <code>run(&quot;cd ...&quot;)</code> because all the <code>run</code> commands are executed in a
separate process and changing the directory there will not affect the rest of the Swift script.</p>
<p>This directory is also used as the base for relative URL&rsquo;s.</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="k">var</span> <span class="nv">workdirectory</span><span class="p">:</span> <span class="kt">String</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 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>
+252
View File
@@ -0,0 +1,252 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>Protocols 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="Protocols 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" />
Protocols 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__">|&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:ZF10SwiftShelloi2ogU___FTQ_FQ_Q0__Q0_">|&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:ZF10SwiftShelloi3oggFTSSPS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:ZF10SwiftShelloi3oggU__FTQ_PS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:ZF10SwiftShelloi3oggUSs12SequenceType_USs13GeneratorType___FTQ_PS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</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>Protocols</h1>
<p>The following protocols are available globally.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:P10SwiftShell18ReadableStreamType"></a>
<a name="//apple_ref/swift/Protocol/ReadableStreamType" class="dashAnchor"></a>
<a class="token" href="#/s:P10SwiftShell18ReadableStreamType">ReadableStreamType</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>A stream of text. Does as much as possible lazily.</p>
<a href="Protocols/ReadableStreamType.html" class="slightly-smaller">See more</a>
</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">protocol</span> <span class="kt">ReadableStreamType</span> <span class="p">:</span> <span class="kt">Streamable</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:P10SwiftShell19WriteableStreamType"></a>
<a name="//apple_ref/swift/Protocol/WriteableStreamType" class="dashAnchor"></a>
<a class="token" href="#/s:P10SwiftShell19WriteableStreamType">WriteableStreamType</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>An output stream, like standard output and standard error.</p>
<a href="Protocols/WriteableStreamType.html" class="slightly-smaller">See more</a>
</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">protocol</span> <span class="kt">WriteableStreamType</span> <span class="p">:</span> <span class="kt">OutputStreamType</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 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>
+311
View File
@@ -0,0 +1,311 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>ReadableStreamType Protocol 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/Protocol/ReadableStreamType" class="dashAnchor"></a>
<a title="ReadableStreamType Protocol 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" />
ReadableStreamType Protocol 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__">|&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:ZF10SwiftShelloi2ogU___FTQ_FQ_Q0__Q0_">|&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:ZF10SwiftShelloi3oggFTSSPS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:ZF10SwiftShelloi3oggU__FTQ_PS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:ZF10SwiftShelloi3oggUSs12SequenceType_USs13GeneratorType___FTQ_PS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</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>ReadableStreamType</h1>
<p>A stream of text. Does as much as possible lazily.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:FP10SwiftShell18ReadableStreamType8readSomeUS0___FQPS0_FT_GSqSS_"></a>
<a name="//apple_ref/swift/Method/readSome()" class="dashAnchor"></a>
<a class="token" href="#/s:FP10SwiftShell18ReadableStreamType8readSomeUS0___FQPS0_FT_GSqSS_">readSome()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Whatever amount of text the stream feels like providing.
If the source is a file this will read everything at once.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">func</span> <span class="nf">readSome</span> <span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">String</span><span class="p">?</span></code></pre>
</div>
</div>
<div>
<h4>Return Value</h4>
<p>more text from the stream, or nil if we have reached the end.</p>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:FP10SwiftShell18ReadableStreamType4readUS0___FQPS0_FT_SS"></a>
<a name="//apple_ref/swift/Method/read()" class="dashAnchor"></a>
<a class="token" href="#/s:FP10SwiftShell18ReadableStreamType4readUS0___FQPS0_FT_SS">read()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Read everything at once.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">func</span> <span class="nf">read</span> <span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">String</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:FP10SwiftShell18ReadableStreamType5linesUS0___FQPS0_FT_GVSs10SequenceOfSS_"></a>
<a name="//apple_ref/swift/Method/lines()" class="dashAnchor"></a>
<a class="token" href="#/s:FP10SwiftShell18ReadableStreamType5linesUS0___FQPS0_FT_GVSs10SequenceOfSS_">lines()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Lazily split the stream into lines.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">func</span> <span class="nf">lines</span> <span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">SequenceOf</span><span class="o">&lt;</span><span class="kt">String</span><span class="o">&gt;</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:FP10SwiftShell18ReadableStreamType7writeToUS0___FQPS0_USs16OutputStreamType__FRQ_T_"></a>
<a name="//apple_ref/swift/Method/writeTo(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:FP10SwiftShell18ReadableStreamType7writeToUS0___FQPS0_USs16OutputStreamType__FRQ_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>Enable stream to be used by <q>println</q> and <q>toString</q>.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">func</span> <span class="n">writeTo</span> <span class="o">&lt;</span><span class="kt">Target</span> <span class="p">:</span> <span class="kt">OutputStreamType</span><span class="o">&gt;</span> <span class="p">(</span><span class="k">inout</span> <span class="nv">target</span><span class="p">:</span> <span class="kt">Target</span><span class="p">)</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 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>
+281
View File
@@ -0,0 +1,281 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>WriteableStreamType Protocol 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/Protocol/WriteableStreamType" class="dashAnchor"></a>
<a title="WriteableStreamType Protocol 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" />
WriteableStreamType Protocol 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__">|&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:ZF10SwiftShelloi2ogU___FTQ_FQ_Q0__Q0_">|&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:ZF10SwiftShelloi3oggFTSSPS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:ZF10SwiftShelloi3oggU__FTQ_PS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:ZF10SwiftShelloi3oggUSs12SequenceType_USs13GeneratorType___FTQ_PS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</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>WriteableStreamType</h1>
<p>An output stream, like standard output and standard error.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:FP10SwiftShell19WriteableStreamType5writeUS0___FQPS0_FSST_"></a>
<a name="//apple_ref/swift/Method/write(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:FP10SwiftShell19WriteableStreamType5writeUS0___FQPS0_FSST_">write(_:)</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:FP10SwiftShell19WriteableStreamType7writelnUS0___FQPS0_FSST_"></a>
<a name="//apple_ref/swift/Method/writeln(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:FP10SwiftShell19WriteableStreamType7writelnUS0___FQPS0_FSST_">writeln(_:)</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:FP10SwiftShell19WriteableStreamType7writelnUS0___FQPS0_FT_T_"></a>
<a name="//apple_ref/swift/Method/writeln()" class="dashAnchor"></a>
<a class="token" href="#/s:FP10SwiftShell19WriteableStreamType7writelnUS0___FQPS0_FT_T_">writeln()</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:FP10SwiftShell19WriteableStreamType11closeStreamUS0___FQPS0_FT_T_"></a>
<a name="//apple_ref/swift/Method/closeStream()" class="dashAnchor"></a>
<a class="token" href="#/s:FP10SwiftShell19WriteableStreamType11closeStreamUS0___FQPS0_FT_T_">closeStream()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Must be called on local streams when finished writing.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">func</span> <span class="nf">closeStream</span> <span class="p">()</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 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>
+202
View File
@@ -0,0 +1,202 @@
/* Credit to https://gist.github.com/wataru420/2048287 */
.highlight {
/* Comment */
/* Error */
/* Keyword */
/* Operator */
/* Comment.Multiline */
/* Comment.Preproc */
/* Comment.Single */
/* Comment.Special */
/* Generic.Deleted */
/* Generic.Deleted.Specific */
/* Generic.Emph */
/* Generic.Error */
/* Generic.Heading */
/* Generic.Inserted */
/* Generic.Inserted.Specific */
/* Generic.Output */
/* Generic.Prompt */
/* Generic.Strong */
/* Generic.Subheading */
/* Generic.Traceback */
/* Keyword.Constant */
/* Keyword.Declaration */
/* Keyword.Pseudo */
/* Keyword.Reserved */
/* Keyword.Type */
/* Literal.Number */
/* Literal.String */
/* Name.Attribute */
/* Name.Builtin */
/* Name.Class */
/* Name.Constant */
/* Name.Entity */
/* Name.Exception */
/* Name.Function */
/* Name.Namespace */
/* Name.Tag */
/* Name.Variable */
/* Operator.Word */
/* Text.Whitespace */
/* Literal.Number.Float */
/* Literal.Number.Hex */
/* Literal.Number.Integer */
/* Literal.Number.Oct */
/* Literal.String.Backtick */
/* Literal.String.Char */
/* Literal.String.Doc */
/* Literal.String.Double */
/* Literal.String.Escape */
/* Literal.String.Heredoc */
/* Literal.String.Interpol */
/* Literal.String.Other */
/* Literal.String.Regex */
/* Literal.String.Single */
/* Literal.String.Symbol */
/* Name.Builtin.Pseudo */
/* Name.Variable.Class */
/* Name.Variable.Global */
/* Name.Variable.Instance */
/* Literal.Number.Integer.Long */ }
.highlight .c {
color: #999988;
font-style: italic; }
.highlight .err {
color: #a61717;
background-color: #e3d2d2; }
.highlight .k {
color: #000000;
font-weight: bold; }
.highlight .o {
color: #000000;
font-weight: bold; }
.highlight .cm {
color: #999988;
font-style: italic; }
.highlight .cp {
color: #999999;
font-weight: bold; }
.highlight .c1 {
color: #999988;
font-style: italic; }
.highlight .cs {
color: #999999;
font-weight: bold;
font-style: italic; }
.highlight .gd {
color: #000000;
background-color: #ffdddd; }
.highlight .gd .x {
color: #000000;
background-color: #ffaaaa; }
.highlight .ge {
color: #000000;
font-style: italic; }
.highlight .gr {
color: #aa0000; }
.highlight .gh {
color: #999999; }
.highlight .gi {
color: #000000;
background-color: #ddffdd; }
.highlight .gi .x {
color: #000000;
background-color: #aaffaa; }
.highlight .go {
color: #888888; }
.highlight .gp {
color: #555555; }
.highlight .gs {
font-weight: bold; }
.highlight .gu {
color: #aaaaaa; }
.highlight .gt {
color: #aa0000; }
.highlight .kc {
color: #000000;
font-weight: bold; }
.highlight .kd {
color: #000000;
font-weight: bold; }
.highlight .kp {
color: #000000;
font-weight: bold; }
.highlight .kr {
color: #000000;
font-weight: bold; }
.highlight .kt {
color: #445588;
font-weight: bold; }
.highlight .m {
color: #009999; }
.highlight .s {
color: #d14; }
.highlight .na {
color: #008080; }
.highlight .nb {
color: #0086B3; }
.highlight .nc {
color: #445588;
font-weight: bold; }
.highlight .no {
color: #008080; }
.highlight .ni {
color: #800080; }
.highlight .ne {
color: #990000;
font-weight: bold; }
.highlight .nf {
color: #990000;
font-weight: bold; }
.highlight .nn {
color: #555555; }
.highlight .nt {
color: #000080; }
.highlight .nv {
color: #008080; }
.highlight .ow {
color: #000000;
font-weight: bold; }
.highlight .w {
color: #bbbbbb; }
.highlight .mf {
color: #009999; }
.highlight .mh {
color: #009999; }
.highlight .mi {
color: #009999; }
.highlight .mo {
color: #009999; }
.highlight .sb {
color: #d14; }
.highlight .sc {
color: #d14; }
.highlight .sd {
color: #d14; }
.highlight .s2 {
color: #d14; }
.highlight .se {
color: #d14; }
.highlight .sh {
color: #d14; }
.highlight .si {
color: #d14; }
.highlight .sx {
color: #d14; }
.highlight .sr {
color: #009926; }
.highlight .s1 {
color: #d14; }
.highlight .ss {
color: #990073; }
.highlight .bp {
color: #999999; }
.highlight .vc {
color: #008080; }
.highlight .vg {
color: #008080; }
.highlight .vi {
color: #008080; }
.highlight .il {
color: #009999; }
+302
View File
@@ -0,0 +1,302 @@
html, body, div, span, h1, h3, h4, p, a, code, em, img, ul, li, table, tbody, tr, td {
background: transparent;
border: 0;
margin: 0;
outline: 0;
padding: 0;
vertical-align: baseline; }
body {
background-color: #f2f2f2;
font-family: Helvetica, freesans, Arial, sans-serif;
font-size: 14px;
-webkit-font-smoothing: subpixel-antialiased;
word-wrap: break-word; }
h1, h2, h3, h4, h5, h6 {
margin-top: 0.8em;
margin-bottom: 0.3em;
font-weight: 100;
color: black; }
h1 {
font-size: 2.5em; }
h2 {
font-size: 2em;
border-bottom: 1px solid #e2e2e2; }
h3 {
font-size: 1.5em; }
h4 {
font-size: 1.25em; }
h5 {
font-size: 1.1em; }
h6 {
font-size: 1.1em;
color: #777; }
pre, code {
font: 0.95em Menlo, monospace;
color: #777;
word-wrap: normal; }
p code, li code {
background-color: #eee;
padding: 2px 4px;
border-radius: 4px; }
a {
color: #0088cc;
text-decoration: none; }
ul {
padding-left: 15px; }
li {
line-height: 1.8em; }
img {
max-width: 100%; }
blockquote {
margin-left: 0;
padding: 0 10px;
border-left: 4px solid #ccc; }
.content-wrapper {
margin: 0 auto;
width: 980px; }
header {
font-size: 0.85em;
line-height: 26px;
background-color: #414141;
position: fixed;
width: 100%;
z-index: 1; }
header img {
padding-right: 6px;
vertical-align: -4px;
height: 16px; }
header a {
color: #fff; }
header p {
float: left;
color: #999; }
header .header-right {
float: right;
margin-left: 16px; }
#breadcrumbs {
background-color: #f2f2f2;
height: 27px;
padding-top: 17px;
position: fixed;
width: 100%;
z-index: 1;
margin-top: 26px; }
#breadcrumbs #carat {
height: 10px;
margin: 0 5px; }
.sidebar {
background-color: #f9f9f9;
border: 1px solid #e2e2e2;
overflow-y: auto;
overflow-x: hidden;
position: fixed;
top: 70px;
bottom: 0;
width: 230px;
word-wrap: normal; }
.nav-groups {
list-style-type: none;
background: #fff;
padding-left: 0; }
.nav-group-name {
border-bottom: 1px solid #e2e2e2;
font-size: 1.1em;
font-weight: 100;
padding: 15px 0 15px 20px; }
.nav-group-name > a {
color: #333; }
.nav-group-tasks {
margin-top: 5px; }
.nav-group-task {
font-size: 0.9em;
list-style-type: none; }
.nav-group-task a {
color: #888; }
.main-content {
background-color: #fff;
border: 1px solid #e2e2e2;
margin-left: 246px;
position: absolute;
overflow: hidden;
padding-bottom: 60px;
top: 70px;
width: 734px; }
.main-content p, .main-content a, .main-content code, .main-content em, .main-content ul, .main-content table, .main-content blockquote {
margin-bottom: 1em; }
.main-content p {
line-height: 1.8em; }
.main-content section .section:first-child {
margin-top: 0;
padding-top: 0; }
.main-content section .task-group-section .task-group:first-of-type {
padding-top: 10px; }
.main-content section .task-group-section .task-group:first-of-type .section-name {
padding-top: 15px; }
.section {
padding: 0 25px; }
.highlight {
background-color: #eee;
padding: 10px 12px;
border: 1px solid #e2e2e2;
border-radius: 4px;
overflow-x: auto; }
.aside-title {
font-size: 9px;
letter-spacing: 2px;
text-transform: uppercase;
padding-bottom: 0; }
.declaration .highlight {
overflow-x: initial;
padding: 0 40px 40px 0;
margin-bottom: -25px;
background-color: transparent;
border: none; }
.section-name {
margin: 0;
margin-left: 18px; }
.task-group-section {
padding-left: 6px;
border-top: 1px solid #e2e2e2; }
.task-group {
padding-top: 0px; }
.item {
padding-top: 8px;
width: 100%;
list-style-type: none; }
.item a[name]:before {
content: "";
display: block;
padding-top: 70px;
margin: -70px 0 0; }
.item code {
background-color: transparent;
padding: 0; }
.item .token {
padding-left: 3px;
margin-left: 15px; }
.pointer-container {
border-bottom: 1px solid #e2e2e2;
left: -23px;
padding-bottom: 13px;
position: relative;
width: 110%; }
.pointer {
background: #f9f9f9;
border-left: 1px solid #e2e2e2;
border-top: 1px solid #e2e2e2;
height: 12px;
left: 21px;
top: -7px;
-webkit-transform: rotate(45deg);
-moz-transform: rotate(45deg);
-o-transform: rotate(45deg);
transform: rotate(45deg);
position: absolute;
width: 12px; }
.height-container {
display: none;
left: -25px;
padding: 0 25px;
position: relative;
width: 100%;
overflow: hidden; }
.height-container .section {
background: #f9f9f9;
border-bottom: 1px solid #e2e2e2;
left: -25px;
position: relative;
width: 100%;
padding-top: 10px;
padding-bottom: 5px; }
div.Swift {
padding: 4px 0 2px 10px;
margin-bottom: 1em;
border-left: 5px solid #cde9f4;
overflow-y: hidden; }
div.Swift .aside-title {
color: #4b8afb;
-webkit-user-select: none; }
.graybox {
border-collapse: collapse;
width: 100%; }
.graybox p {
margin: 0;
word-break: break-word;
min-width: 50px; }
.graybox td {
border: 1px solid #e2e2e2;
padding: 5px 25px 5px 10px;
vertical-align: middle; }
.graybox tr td:first-of-type {
text-align: right;
padding: 7px;
vertical-align: top;
word-break: normal;
width: 40px; }
.slightly-smaller {
font-size: 0.9em; }
#footer {
position: absolute;
bottom: 10px;
margin-left: 25px; }
#footer p {
margin: 0;
color: #aaa;
font-size: 0.8em; }
html.dash header, html.dash #breadcrumbs, html.dash .sidebar {
display: none; }
html.dash .main-content {
width: 980px;
margin-left: 0;
border: none;
width: auto;
top: 0;
padding-bottom: 0; }
html.dash .height-container {
display: block; }
html.dash .item .token {
margin-left: 0; }
html.dash .content-wrapper {
width: auto; }
html.dash #footer {
position: static; }
+20
View File
@@ -0,0 +1,20 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>CFBundleIdentifier</key>
<string>com.jazzy.</string>
<key>CFBundleName</key>
<string></string>
<key>DocSetPlatformFamily</key>
<string>jazzy</string>
<key>isDashDocset</key>
<true/>
<key>dashIndexFilePath</key>
<string>index.html</string>
<key>isJavaScriptEnabled</key>
<true/>
<key>DashDocSetFamily</key>
<string>dashtoc</string>
</dict>
</plist>
@@ -0,0 +1,247 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>Extensions 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="Extensions 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" />
Extensions 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__">|&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:ZF10SwiftShelloi2ogU___FTQ_FQ_Q0__Q0_">|&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:ZF10SwiftShelloi3oggFTSSPS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:ZF10SwiftShelloi3oggU__FTQ_PS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:ZF10SwiftShelloi3oggUSs12SequenceType_USs13GeneratorType___FTQ_PS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</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>Extensions</h1>
<p>The following extensions are available globally.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:SS"></a>
<a name="//apple_ref/swift/Extension/String" class="dashAnchor"></a>
<a class="token" href="#/s:SS">String</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<a href="Extensions/String.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">struct</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:10SwiftShell10FileHandle"></a>
<a name="//apple_ref/swift/Extension/FileHandle" class="dashAnchor"></a>
<a class="token" href="#/s:10SwiftShell10FileHandle">FileHandle</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>
<a href="Extensions/FileHandle.html" class="slightly-smaller">See more</a>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 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>
@@ -0,0 +1,353 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>FileHandle Extension 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/Extension/FileHandle" class="dashAnchor"></a>
<a title="FileHandle Extension 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" />
FileHandle Extension 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__">|&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:ZF10SwiftShelloi2ogU___FTQ_FQ_Q0__Q0_">|&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:ZF10SwiftShelloi3oggFTSSPS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:ZF10SwiftShelloi3oggU__FTQ_PS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:ZF10SwiftShelloi3oggUSs12SequenceType_USs13GeneratorType___FTQ_PS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</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>FileHandle</h1>
<p>Undocumented</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:FE10SwiftShellCSo12NSFileHandle8readSomeFS0_FT_GSqSS_"></a>
<a name="//apple_ref/swift/Method/readSome()" class="dashAnchor"></a>
<a class="token" href="#/s:FE10SwiftShellCSo12NSFileHandle8readSomeFS0_FT_GSqSS_">readSome()</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:FE10SwiftShellCSo12NSFileHandle4readFS0_FT_SS"></a>
<a name="//apple_ref/swift/Method/read()" class="dashAnchor"></a>
<a class="token" href="#/s:FE10SwiftShellCSo12NSFileHandle4readFS0_FT_SS">read()</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:FE10SwiftShellCSo12NSFileHandle5linesFS0_FT_GVSs10SequenceOfSS_"></a>
<a name="//apple_ref/swift/Method/lines()" class="dashAnchor"></a>
<a class="token" href="#/s:FE10SwiftShellCSo12NSFileHandle5linesFS0_FT_GVSs10SequenceOfSS_">lines()</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:FE10SwiftShellCSo12NSFileHandle7writeToFS0_USs16OutputStreamType__FRQ_T_"></a>
<a name="//apple_ref/swift/Method/writeTo(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:FE10SwiftShellCSo12NSFileHandle7writeToFS0_USs16OutputStreamType__FRQ_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>Undocumented</p>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:FE10SwiftShellCSo12NSFileHandle5writeFS0_FSST_"></a>
<a name="//apple_ref/swift/Method/write(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:FE10SwiftShellCSo12NSFileHandle5writeFS0_FSST_">write(_:)</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:FE10SwiftShellCSo12NSFileHandle7writelnFS0_FSST_"></a>
<a name="//apple_ref/swift/Method/writeln(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:FE10SwiftShellCSo12NSFileHandle7writelnFS0_FSST_">writeln(_:)</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:FE10SwiftShellCSo12NSFileHandle7writelnFS0_FT_T_"></a>
<a name="//apple_ref/swift/Method/writeln()" class="dashAnchor"></a>
<a class="token" href="#/s:FE10SwiftShellCSo12NSFileHandle7writelnFS0_FT_T_">writeln()</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:FE10SwiftShellCSo12NSFileHandle11closeStreamFS0_FT_T_"></a>
<a name="//apple_ref/swift/Method/closeStream()" class="dashAnchor"></a>
<a class="token" href="#/s:FE10SwiftShellCSo12NSFileHandle11closeStreamFS0_FT_T_">closeStream()</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>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 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>
@@ -0,0 +1,355 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>String Extension 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/Extension/String" class="dashAnchor"></a>
<a title="String Extension 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" />
String Extension 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__">|&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:ZF10SwiftShelloi2ogU___FTQ_FQ_Q0__Q0_">|&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:ZF10SwiftShelloi3oggFTSSPS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:ZF10SwiftShelloi3oggU__FTQ_PS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:ZF10SwiftShelloi3oggUSs12SequenceType_USs13GeneratorType___FTQ_PS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</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>String</h1>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:FE10SwiftShellSS7replaceFSSFTSSSS_SS"></a>
<a name="//apple_ref/swift/Method/replace(_:_:)" class="dashAnchor"></a>
<a class="token" href="#/s:FE10SwiftShellSS7replaceFSSFTSSSS_SS">replace(_:_:)</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:FE10SwiftShellSS7replaceFSSFTSSSS5limitSi_SS"></a>
<a name="//apple_ref/swift/Method/replace(_:_:limit:)" class="dashAnchor"></a>
<a class="token" href="#/s:FE10SwiftShellSS7replaceFSSFTSSSS5limitSi_SS">replace(_:_:limit:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Replace the first <code>limit</code> occurrences of oldString with newString.</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">replace</span> <span class="p">(</span><span class="nv">oldString</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="n">_</span> <span class="nv">newString</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">limit</span><span class="p">:</span> <span class="kt">Int</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">String</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:FE10SwiftShellSS5splitFSSFSSGSaSS_"></a>
<a name="//apple_ref/swift/Method/split(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:FE10SwiftShellSS5splitFSSFSSGSaSS_">split(_:)</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:FE10SwiftShellSS4trimFSSFT_SS"></a>
<a name="//apple_ref/swift/Method/trim()" class="dashAnchor"></a>
<a class="token" href="#/s:FE10SwiftShellSS4trimFSSFT_SS">trim()</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:FE10SwiftShellSS18countOccurrencesOfFSSFSSSi"></a>
<a name="//apple_ref/swift/Method/countOccurrencesOf(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:FE10SwiftShellSS18countOccurrencesOfFSSFSSSi">countOccurrencesOf(_:)</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:FE10SwiftShellSS7findAllFSSFSSGVSs10SequenceOfGVSs5RangeVSS5Index__"></a>
<a name="//apple_ref/swift/Method/findAll(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:FE10SwiftShellSS7findAllFSSFSSGVSs10SequenceOfGVSs5RangeVSS5Index__">findAll(_:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>A lazy sequence of the ranges of <code>findstring</code> in this 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">findAll</span> <span class="p">(</span><span class="nv">findstring</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">SequenceOf</span><span class="o">&lt;</span><span class="kt">Range</span><span class="o">&lt;</span><span class="kt">String</span><span class="o">.</span><span class="kt">Index</span><span class="o">&gt;&gt;</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:FE10SwiftShellSS9partitionFSSFSSTSSSSSS_"></a>
<a name="//apple_ref/swift/Method/partition(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:FE10SwiftShellSS9partitionFSSFSSTSSSSSS_">partition(_:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Split the string at the first occurrence of separator, and return a 3-tuple containing the part
before the separator, the separator itself, and the part after the separator. If the separator is
not found, return a 3-tuple containing the string itself, followed by two empty 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="nf">partition</span> <span class="p">(</span><span class="nv">separator</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="p">(</span><span class="kt">String</span><span class="p">,</span> <span class="kt">String</span><span class="p">,</span> <span class="kt">String</span><span class="p">)</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 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>
File diff suppressed because it is too large Load Diff
@@ -0,0 +1,386 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>Global Variables 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="Global Variables 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" />
Global Variables 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__">|&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:ZF10SwiftShelloi2ogU___FTQ_FQ_Q0__Q0_">|&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:ZF10SwiftShelloi3oggFTSSPS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:ZF10SwiftShelloi3oggU__FTQ_PS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:ZF10SwiftShelloi3oggUSs12SequenceType_USs13GeneratorType___FTQ_PS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</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>Global Variables</h1>
<p>The following global variables are available globally.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:v10SwiftShell11environmentGVSs10DictionarySSSS_"></a>
<a name="//apple_ref/swift/Global/environment" class="dashAnchor"></a>
<a class="token" href="#/s:v10SwiftShell11environmentGVSs10DictionarySSSS_">environment</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:v10SwiftShell13standardinputPS_18ReadableStreamType_"></a>
<a name="//apple_ref/swift/Global/standardinput" class="dashAnchor"></a>
<a class="token" href="#/s:v10SwiftShell13standardinputPS_18ReadableStreamType_">standardinput</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:v10SwiftShell14standardoutputPS_19WriteableStreamType_"></a>
<a name="//apple_ref/swift/Global/standardoutput" class="dashAnchor"></a>
<a class="token" href="#/s:v10SwiftShell14standardoutputPS_19WriteableStreamType_">standardoutput</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:v10SwiftShell13standarderrorPS_19WriteableStreamType_"></a>
<a name="//apple_ref/swift/Global/standarderror" class="dashAnchor"></a>
<a class="token" href="#/s:v10SwiftShell13standarderrorPS_19WriteableStreamType_">standarderror</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>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:v10SwiftShell14streamencodingSu"></a>
<a name="//apple_ref/swift/Global/streamencoding" class="dashAnchor"></a>
<a class="token" href="#/s:v10SwiftShell14streamencodingSu">streamencoding</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>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:v10SwiftShell4FileCSo13NSFileManager"></a>
<a name="//apple_ref/swift/Global/File" class="dashAnchor"></a>
<a class="token" href="#/s:v10SwiftShell4FileCSo13NSFileManager">File</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The default NSFileManager</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="k">let</span> <span class="nv">File</span> <span class="o">=</span> <span class="kt">NSFileManager</span><span class="o">.</span><span class="nf">defaultManager</span><span class="p">()</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:v10SwiftShell13tempdirectorySS"></a>
<a name="//apple_ref/swift/Global/tempdirectory" class="dashAnchor"></a>
<a class="token" href="#/s:v10SwiftShell13tempdirectorySS">tempdirectory</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The tempdirectory is unique each time a script is run and is created the first time it is used.
It lies in the user&rsquo;s temporary directory and will be automatically deleted at some point.</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="k">let</span> <span class="nv">tempdirectory</span><span class="p">:</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:v10SwiftShell13workdirectorySS"></a>
<a name="//apple_ref/swift/Global/workdirectory" class="dashAnchor"></a>
<a class="token" href="#/s:v10SwiftShell13workdirectorySS">workdirectory</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The current working directory.</p>
<p>Must be used instead of <code>run(&quot;cd ...&quot;)</code> because all the <code>run</code> commands are executed in a
separate process and changing the directory there will not affect the rest of the Swift script.</p>
<p>This directory is also used as the base for relative URL&rsquo;s.</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="k">var</span> <span class="nv">workdirectory</span><span class="p">:</span> <span class="kt">String</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 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>
@@ -0,0 +1,252 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>Protocols 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="Protocols 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" />
Protocols 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__">|&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:ZF10SwiftShelloi2ogU___FTQ_FQ_Q0__Q0_">|&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:ZF10SwiftShelloi3oggFTSSPS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:ZF10SwiftShelloi3oggU__FTQ_PS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:ZF10SwiftShelloi3oggUSs12SequenceType_USs13GeneratorType___FTQ_PS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</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>Protocols</h1>
<p>The following protocols are available globally.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:P10SwiftShell18ReadableStreamType"></a>
<a name="//apple_ref/swift/Protocol/ReadableStreamType" class="dashAnchor"></a>
<a class="token" href="#/s:P10SwiftShell18ReadableStreamType">ReadableStreamType</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>A stream of text. Does as much as possible lazily.</p>
<a href="Protocols/ReadableStreamType.html" class="slightly-smaller">See more</a>
</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">protocol</span> <span class="kt">ReadableStreamType</span> <span class="p">:</span> <span class="kt">Streamable</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:P10SwiftShell19WriteableStreamType"></a>
<a name="//apple_ref/swift/Protocol/WriteableStreamType" class="dashAnchor"></a>
<a class="token" href="#/s:P10SwiftShell19WriteableStreamType">WriteableStreamType</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>An output stream, like standard output and standard error.</p>
<a href="Protocols/WriteableStreamType.html" class="slightly-smaller">See more</a>
</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">protocol</span> <span class="kt">WriteableStreamType</span> <span class="p">:</span> <span class="kt">OutputStreamType</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 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>
@@ -0,0 +1,311 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>ReadableStreamType Protocol 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/Protocol/ReadableStreamType" class="dashAnchor"></a>
<a title="ReadableStreamType Protocol 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" />
ReadableStreamType Protocol 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__">|&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:ZF10SwiftShelloi2ogU___FTQ_FQ_Q0__Q0_">|&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:ZF10SwiftShelloi3oggFTSSPS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:ZF10SwiftShelloi3oggU__FTQ_PS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:ZF10SwiftShelloi3oggUSs12SequenceType_USs13GeneratorType___FTQ_PS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</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>ReadableStreamType</h1>
<p>A stream of text. Does as much as possible lazily.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:FP10SwiftShell18ReadableStreamType8readSomeUS0___FQPS0_FT_GSqSS_"></a>
<a name="//apple_ref/swift/Method/readSome()" class="dashAnchor"></a>
<a class="token" href="#/s:FP10SwiftShell18ReadableStreamType8readSomeUS0___FQPS0_FT_GSqSS_">readSome()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Whatever amount of text the stream feels like providing.
If the source is a file this will read everything at once.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">func</span> <span class="nf">readSome</span> <span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">String</span><span class="p">?</span></code></pre>
</div>
</div>
<div>
<h4>Return Value</h4>
<p>more text from the stream, or nil if we have reached the end.</p>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:FP10SwiftShell18ReadableStreamType4readUS0___FQPS0_FT_SS"></a>
<a name="//apple_ref/swift/Method/read()" class="dashAnchor"></a>
<a class="token" href="#/s:FP10SwiftShell18ReadableStreamType4readUS0___FQPS0_FT_SS">read()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Read everything at once.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">func</span> <span class="nf">read</span> <span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">String</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:FP10SwiftShell18ReadableStreamType5linesUS0___FQPS0_FT_GVSs10SequenceOfSS_"></a>
<a name="//apple_ref/swift/Method/lines()" class="dashAnchor"></a>
<a class="token" href="#/s:FP10SwiftShell18ReadableStreamType5linesUS0___FQPS0_FT_GVSs10SequenceOfSS_">lines()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Lazily split the stream into lines.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">func</span> <span class="nf">lines</span> <span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">SequenceOf</span><span class="o">&lt;</span><span class="kt">String</span><span class="o">&gt;</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:FP10SwiftShell18ReadableStreamType7writeToUS0___FQPS0_USs16OutputStreamType__FRQ_T_"></a>
<a name="//apple_ref/swift/Method/writeTo(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:FP10SwiftShell18ReadableStreamType7writeToUS0___FQPS0_USs16OutputStreamType__FRQ_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>Enable stream to be used by <q>println</q> and <q>toString</q>.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">func</span> <span class="n">writeTo</span> <span class="o">&lt;</span><span class="kt">Target</span> <span class="p">:</span> <span class="kt">OutputStreamType</span><span class="o">&gt;</span> <span class="p">(</span><span class="k">inout</span> <span class="nv">target</span><span class="p">:</span> <span class="kt">Target</span><span class="p">)</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 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>
@@ -0,0 +1,281 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>WriteableStreamType Protocol 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/Protocol/WriteableStreamType" class="dashAnchor"></a>
<a title="WriteableStreamType Protocol 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" />
WriteableStreamType Protocol 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__">|&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:ZF10SwiftShelloi2ogU___FTQ_FQ_Q0__Q0_">|&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:ZF10SwiftShelloi3oggFTSSPS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:ZF10SwiftShelloi3oggU__FTQ_PS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:ZF10SwiftShelloi3oggUSs12SequenceType_USs13GeneratorType___FTQ_PS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</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>WriteableStreamType</h1>
<p>An output stream, like standard output and standard error.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:FP10SwiftShell19WriteableStreamType5writeUS0___FQPS0_FSST_"></a>
<a name="//apple_ref/swift/Method/write(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:FP10SwiftShell19WriteableStreamType5writeUS0___FQPS0_FSST_">write(_:)</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:FP10SwiftShell19WriteableStreamType7writelnUS0___FQPS0_FSST_"></a>
<a name="//apple_ref/swift/Method/writeln(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:FP10SwiftShell19WriteableStreamType7writelnUS0___FQPS0_FSST_">writeln(_:)</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:FP10SwiftShell19WriteableStreamType7writelnUS0___FQPS0_FT_T_"></a>
<a name="//apple_ref/swift/Method/writeln()" class="dashAnchor"></a>
<a class="token" href="#/s:FP10SwiftShell19WriteableStreamType7writelnUS0___FQPS0_FT_T_">writeln()</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:FP10SwiftShell19WriteableStreamType11closeStreamUS0___FQPS0_FT_T_"></a>
<a name="//apple_ref/swift/Method/closeStream()" class="dashAnchor"></a>
<a class="token" href="#/s:FP10SwiftShell19WriteableStreamType11closeStreamUS0___FQPS0_FT_T_">closeStream()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Must be called on local streams when finished writing.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">func</span> <span class="nf">closeStream</span> <span class="p">()</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 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>
@@ -0,0 +1,202 @@
/* Credit to https://gist.github.com/wataru420/2048287 */
.highlight {
/* Comment */
/* Error */
/* Keyword */
/* Operator */
/* Comment.Multiline */
/* Comment.Preproc */
/* Comment.Single */
/* Comment.Special */
/* Generic.Deleted */
/* Generic.Deleted.Specific */
/* Generic.Emph */
/* Generic.Error */
/* Generic.Heading */
/* Generic.Inserted */
/* Generic.Inserted.Specific */
/* Generic.Output */
/* Generic.Prompt */
/* Generic.Strong */
/* Generic.Subheading */
/* Generic.Traceback */
/* Keyword.Constant */
/* Keyword.Declaration */
/* Keyword.Pseudo */
/* Keyword.Reserved */
/* Keyword.Type */
/* Literal.Number */
/* Literal.String */
/* Name.Attribute */
/* Name.Builtin */
/* Name.Class */
/* Name.Constant */
/* Name.Entity */
/* Name.Exception */
/* Name.Function */
/* Name.Namespace */
/* Name.Tag */
/* Name.Variable */
/* Operator.Word */
/* Text.Whitespace */
/* Literal.Number.Float */
/* Literal.Number.Hex */
/* Literal.Number.Integer */
/* Literal.Number.Oct */
/* Literal.String.Backtick */
/* Literal.String.Char */
/* Literal.String.Doc */
/* Literal.String.Double */
/* Literal.String.Escape */
/* Literal.String.Heredoc */
/* Literal.String.Interpol */
/* Literal.String.Other */
/* Literal.String.Regex */
/* Literal.String.Single */
/* Literal.String.Symbol */
/* Name.Builtin.Pseudo */
/* Name.Variable.Class */
/* Name.Variable.Global */
/* Name.Variable.Instance */
/* Literal.Number.Integer.Long */ }
.highlight .c {
color: #999988;
font-style: italic; }
.highlight .err {
color: #a61717;
background-color: #e3d2d2; }
.highlight .k {
color: #000000;
font-weight: bold; }
.highlight .o {
color: #000000;
font-weight: bold; }
.highlight .cm {
color: #999988;
font-style: italic; }
.highlight .cp {
color: #999999;
font-weight: bold; }
.highlight .c1 {
color: #999988;
font-style: italic; }
.highlight .cs {
color: #999999;
font-weight: bold;
font-style: italic; }
.highlight .gd {
color: #000000;
background-color: #ffdddd; }
.highlight .gd .x {
color: #000000;
background-color: #ffaaaa; }
.highlight .ge {
color: #000000;
font-style: italic; }
.highlight .gr {
color: #aa0000; }
.highlight .gh {
color: #999999; }
.highlight .gi {
color: #000000;
background-color: #ddffdd; }
.highlight .gi .x {
color: #000000;
background-color: #aaffaa; }
.highlight .go {
color: #888888; }
.highlight .gp {
color: #555555; }
.highlight .gs {
font-weight: bold; }
.highlight .gu {
color: #aaaaaa; }
.highlight .gt {
color: #aa0000; }
.highlight .kc {
color: #000000;
font-weight: bold; }
.highlight .kd {
color: #000000;
font-weight: bold; }
.highlight .kp {
color: #000000;
font-weight: bold; }
.highlight .kr {
color: #000000;
font-weight: bold; }
.highlight .kt {
color: #445588;
font-weight: bold; }
.highlight .m {
color: #009999; }
.highlight .s {
color: #d14; }
.highlight .na {
color: #008080; }
.highlight .nb {
color: #0086B3; }
.highlight .nc {
color: #445588;
font-weight: bold; }
.highlight .no {
color: #008080; }
.highlight .ni {
color: #800080; }
.highlight .ne {
color: #990000;
font-weight: bold; }
.highlight .nf {
color: #990000;
font-weight: bold; }
.highlight .nn {
color: #555555; }
.highlight .nt {
color: #000080; }
.highlight .nv {
color: #008080; }
.highlight .ow {
color: #000000;
font-weight: bold; }
.highlight .w {
color: #bbbbbb; }
.highlight .mf {
color: #009999; }
.highlight .mh {
color: #009999; }
.highlight .mi {
color: #009999; }
.highlight .mo {
color: #009999; }
.highlight .sb {
color: #d14; }
.highlight .sc {
color: #d14; }
.highlight .sd {
color: #d14; }
.highlight .s2 {
color: #d14; }
.highlight .se {
color: #d14; }
.highlight .sh {
color: #d14; }
.highlight .si {
color: #d14; }
.highlight .sx {
color: #d14; }
.highlight .sr {
color: #009926; }
.highlight .s1 {
color: #d14; }
.highlight .ss {
color: #990073; }
.highlight .bp {
color: #999999; }
.highlight .vc {
color: #008080; }
.highlight .vg {
color: #008080; }
.highlight .vi {
color: #008080; }
.highlight .il {
color: #009999; }
@@ -0,0 +1,302 @@
html, body, div, span, h1, h3, h4, p, a, code, em, img, ul, li, table, tbody, tr, td {
background: transparent;
border: 0;
margin: 0;
outline: 0;
padding: 0;
vertical-align: baseline; }
body {
background-color: #f2f2f2;
font-family: Helvetica, freesans, Arial, sans-serif;
font-size: 14px;
-webkit-font-smoothing: subpixel-antialiased;
word-wrap: break-word; }
h1, h2, h3, h4, h5, h6 {
margin-top: 0.8em;
margin-bottom: 0.3em;
font-weight: 100;
color: black; }
h1 {
font-size: 2.5em; }
h2 {
font-size: 2em;
border-bottom: 1px solid #e2e2e2; }
h3 {
font-size: 1.5em; }
h4 {
font-size: 1.25em; }
h5 {
font-size: 1.1em; }
h6 {
font-size: 1.1em;
color: #777; }
pre, code {
font: 0.95em Menlo, monospace;
color: #777;
word-wrap: normal; }
p code, li code {
background-color: #eee;
padding: 2px 4px;
border-radius: 4px; }
a {
color: #0088cc;
text-decoration: none; }
ul {
padding-left: 15px; }
li {
line-height: 1.8em; }
img {
max-width: 100%; }
blockquote {
margin-left: 0;
padding: 0 10px;
border-left: 4px solid #ccc; }
.content-wrapper {
margin: 0 auto;
width: 980px; }
header {
font-size: 0.85em;
line-height: 26px;
background-color: #414141;
position: fixed;
width: 100%;
z-index: 1; }
header img {
padding-right: 6px;
vertical-align: -4px;
height: 16px; }
header a {
color: #fff; }
header p {
float: left;
color: #999; }
header .header-right {
float: right;
margin-left: 16px; }
#breadcrumbs {
background-color: #f2f2f2;
height: 27px;
padding-top: 17px;
position: fixed;
width: 100%;
z-index: 1;
margin-top: 26px; }
#breadcrumbs #carat {
height: 10px;
margin: 0 5px; }
.sidebar {
background-color: #f9f9f9;
border: 1px solid #e2e2e2;
overflow-y: auto;
overflow-x: hidden;
position: fixed;
top: 70px;
bottom: 0;
width: 230px;
word-wrap: normal; }
.nav-groups {
list-style-type: none;
background: #fff;
padding-left: 0; }
.nav-group-name {
border-bottom: 1px solid #e2e2e2;
font-size: 1.1em;
font-weight: 100;
padding: 15px 0 15px 20px; }
.nav-group-name > a {
color: #333; }
.nav-group-tasks {
margin-top: 5px; }
.nav-group-task {
font-size: 0.9em;
list-style-type: none; }
.nav-group-task a {
color: #888; }
.main-content {
background-color: #fff;
border: 1px solid #e2e2e2;
margin-left: 246px;
position: absolute;
overflow: hidden;
padding-bottom: 60px;
top: 70px;
width: 734px; }
.main-content p, .main-content a, .main-content code, .main-content em, .main-content ul, .main-content table, .main-content blockquote {
margin-bottom: 1em; }
.main-content p {
line-height: 1.8em; }
.main-content section .section:first-child {
margin-top: 0;
padding-top: 0; }
.main-content section .task-group-section .task-group:first-of-type {
padding-top: 10px; }
.main-content section .task-group-section .task-group:first-of-type .section-name {
padding-top: 15px; }
.section {
padding: 0 25px; }
.highlight {
background-color: #eee;
padding: 10px 12px;
border: 1px solid #e2e2e2;
border-radius: 4px;
overflow-x: auto; }
.aside-title {
font-size: 9px;
letter-spacing: 2px;
text-transform: uppercase;
padding-bottom: 0; }
.declaration .highlight {
overflow-x: initial;
padding: 0 40px 40px 0;
margin-bottom: -25px;
background-color: transparent;
border: none; }
.section-name {
margin: 0;
margin-left: 18px; }
.task-group-section {
padding-left: 6px;
border-top: 1px solid #e2e2e2; }
.task-group {
padding-top: 0px; }
.item {
padding-top: 8px;
width: 100%;
list-style-type: none; }
.item a[name]:before {
content: "";
display: block;
padding-top: 70px;
margin: -70px 0 0; }
.item code {
background-color: transparent;
padding: 0; }
.item .token {
padding-left: 3px;
margin-left: 15px; }
.pointer-container {
border-bottom: 1px solid #e2e2e2;
left: -23px;
padding-bottom: 13px;
position: relative;
width: 110%; }
.pointer {
background: #f9f9f9;
border-left: 1px solid #e2e2e2;
border-top: 1px solid #e2e2e2;
height: 12px;
left: 21px;
top: -7px;
-webkit-transform: rotate(45deg);
-moz-transform: rotate(45deg);
-o-transform: rotate(45deg);
transform: rotate(45deg);
position: absolute;
width: 12px; }
.height-container {
display: none;
left: -25px;
padding: 0 25px;
position: relative;
width: 100%;
overflow: hidden; }
.height-container .section {
background: #f9f9f9;
border-bottom: 1px solid #e2e2e2;
left: -25px;
position: relative;
width: 100%;
padding-top: 10px;
padding-bottom: 5px; }
div.Swift {
padding: 4px 0 2px 10px;
margin-bottom: 1em;
border-left: 5px solid #cde9f4;
overflow-y: hidden; }
div.Swift .aside-title {
color: #4b8afb;
-webkit-user-select: none; }
.graybox {
border-collapse: collapse;
width: 100%; }
.graybox p {
margin: 0;
word-break: break-word;
min-width: 50px; }
.graybox td {
border: 1px solid #e2e2e2;
padding: 5px 25px 5px 10px;
vertical-align: middle; }
.graybox tr td:first-of-type {
text-align: right;
padding: 7px;
vertical-align: top;
word-break: normal;
width: 40px; }
.slightly-smaller {
font-size: 0.9em; }
#footer {
position: absolute;
bottom: 10px;
margin-left: 25px; }
#footer p {
margin: 0;
color: #aaa;
font-size: 0.8em; }
html.dash header, html.dash #breadcrumbs, html.dash .sidebar {
display: none; }
html.dash .main-content {
width: 980px;
margin-left: 0;
border: none;
width: auto;
top: 0;
padding-bottom: 0; }
html.dash .height-container {
display: block; }
html.dash .item .token {
margin-left: 0; }
html.dash .content-wrapper {
width: auto; }
html.dash #footer {
position: static; }
Binary file not shown.

After

Width:  |  Height:  |  Size: 274 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.5 KiB

@@ -0,0 +1,279 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title> 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=" 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" />
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__">|&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:ZF10SwiftShelloi2ogU___FTQ_FQ_Q0__Q0_">|&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:ZF10SwiftShelloi3oggFTSSPS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:ZF10SwiftShelloi3oggU__FTQ_PS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:ZF10SwiftShelloi3oggUSs12SequenceType_USs13GeneratorType___FTQ_PS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</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">
<p><em>Updated to <a href="https://developer.apple.com/swift/blog/?id=22">Swift 1.2</a> (Xcode 6.3). <a href="https://github.com/kareman/SwiftShell/releases/tag/v0.1">Use this</a> for earlier versions of Swift (Xcode 6.1.1 and 6.2).</em></p>
<a href='#swiftshell' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h1 id='swiftshell'>SwiftShell</h1>
<p>An OS X Framework for command line scripting in Swift. It supports joining together shell commands and Swift functions, like the pipe in shell commands and the pipe forward operator in F#.</p>
<a href='#usage' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h2 id='usage'>Usage</h2>
<a href='#commands' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h4 id='commands'>Commands</h4>
<p>Shell commands return readable streams, which can be read all at once with <q>read()</q> or read lazily (as in piece by piece) with <q>readSome()</q>. The latter is useful for long texts.</p>
<pre class="highlight swift"><code><span class="cp">#!/usr/bin/env swiftshell</span>
<span class="kd">import</span> <span class="kt">SwiftShell</span>
<span class="k">let</span> <span class="nv">result</span> <span class="o">=</span> <span class="nf">run</span><span class="p">(</span><span class="s">"some shell command"</span><span class="p">)</span><span class="o">.</span><span class="nf">read</span><span class="p">()</span>
</code></pre>
<p>Commands can be piped together:</p>
<pre class="highlight swift"><code><span class="nf">run</span><span class="p">(</span><span class="s">"echo piped to the next command"</span><span class="p">)</span> <span class="o">|&gt;</span> <span class="nf">run</span><span class="p">(</span><span class="s">"wc -w"</span><span class="p">)</span> <span class="o">|&gt;&gt;</span> <span class="n">standardoutput</span>
</code></pre>
<p>Use any sequence as parameters for a command:</p>
<pre class="highlight swift"><code><span class="nf">run</span><span class="p">(</span> <span class="s">"chmod +x"</span> <span class="o">+</span> <span class="nf">parameters</span><span class="p">(</span><span class="n">files</span><span class="p">)</span> <span class="p">)</span>
</code></pre>
<p>For in-line commands, use <code>$(&quot;command&quot;)</code>:</p>
<pre class="highlight swift"><code><span class="nf">print</span><span class="p">(</span> <span class="s">"The time and date is "</span> <span class="o">+</span> <span class="err">$</span><span class="p">(</span><span class="s">"date -u"</span><span class="p">)</span> <span class="p">)</span>
</code></pre>
<a href='#files' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h4 id='files'>Files</h4>
<p>Files are streams too. They can be read line by line:</p>
<pre class="highlight swift"><code><span class="k">for</span> <span class="n">line</span> <span class="k">in</span> <span class="nf">open</span><span class="p">(</span><span class="s">"file1.txt"</span><span class="p">)</span><span class="o">.</span><span class="nf">lines</span><span class="p">()</span> <span class="p">{</span>
<span class="c1">// Do something with each line</span>
<span class="p">}</span>
</code></pre>
<p>Or written to:</p>
<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">file2</span> <span class="o">=</span> <span class="nf">open</span><span class="p">(</span><span class="nv">forWriting</span><span class="p">:</span> <span class="n">tempdirectory</span> <span class="o">/</span> <span class="s">"newfile.txt"</span> <span class="p">)</span>
<span class="nf">run</span><span class="p">(</span><span class="s">"echo line 1"</span><span class="p">)</span> <span class="o">|&gt;&gt;</span> <span class="n">file2</span>
<span class="n">file2</span><span class="o">.</span><span class="nf">writeln</span><span class="p">(</span><span class="s">"line 2"</span><span class="p">)</span>
</code></pre>
<p>And there&rsquo;s easy access to NSFileManager:</p>
<pre class="highlight swift"><code><span class="k">if</span> <span class="kt">File</span><span class="o">.</span><span class="nf">fileExistsAtPath</span><span class="p">(</span><span class="s">"fileiwant.txt"</span><span class="p">)</span> <span class="p">{</span><span class="o">...</span><span class="p">}</span>
<span class="k">if</span> <span class="kt">File</span><span class="o">.</span><span class="nf">isExecutableFileAtPath</span><span class="p">(</span><span class="s">"program"</span><span class="p">)</span> <span class="p">{</span><span class="o">...</span><span class="p">}</span>
<span class="o">...</span>
</code></pre>
<a href='#standard_input' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h4 id='standard_input'>Standard input</h4>
<p>is also a stream:</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">i</span> <span class="o">=</span> <span class="mi">1</span>
<span class="k">for</span> <span class="n">line</span> <span class="k">in</span> <span class="n">standardinput</span><span class="o">.</span><span class="nf">lines</span><span class="p">()</span> <span class="p">{</span>
<span class="nf">print</span><span class="p">(</span><span class="s">"line </span><span class="se">\(</span><span class="n">i</span><span class="o">++</span><span class="se">)</span><span class="s">: "</span><span class="p">)</span>
<span class="nf">println</span><span class="p">(</span><span class="n">line</span><span class="p">)</span>
<span class="p">}</span>
</code></pre>
<p>or</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">i</span> <span class="o">=</span> <span class="mi">1</span>
<span class="n">standardinput</span><span class="o">.</span><span class="nf">lines</span><span class="p">()</span> <span class="o">|&gt;</span> <span class="n">map</span> <span class="p">{</span><span class="n">line</span> <span class="k">in</span> <span class="s">"line </span><span class="se">\(</span><span class="n">i</span><span class="o">++</span><span class="se">)</span><span class="s">: </span><span class="se">\(</span><span class="n">line</span><span class="se">)\n</span><span class="s">"</span><span class="p">}</span> <span class="o">|&gt;&gt;</span> <span class="n">standardoutput</span>
</code></pre>
<p>Launch with e.g. <code>ls | print_linenumbers.swift</code></p>
<a href='#examples' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h2 id='examples'>Examples</h2>
<ul>
<li><a href="https://gist.github.com/kareman/322c1091f3cc7e1078af">trash.swift</a>: moves files and folders to the trash.</li>
<li><a href="https://gist.github.com/kareman/d157c46858f91f1a22a7">listallexecutablesinpath.swift</a>: lists all executables currently available in PATH.</li>
</ul>
<a href='#installation' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h2 id='installation'>Installation</h2>
<ul>
<li>In the Terminal, go to where you want to download SwiftShell.</li>
<li><p>Run</p>
<pre class="highlight plaintext"><code>git clone https://github.com/kareman/SwiftShell.git
cd SwiftShell
</code></pre></li>
<li><p>Copy/link <code>Misc/swiftshell</code> to your bin folder or anywhere in your PATH.</p></li>
<li><p>To install the framework itself, either:</p>
<ul>
<li>run <code>xcodebuild install</code> from the project&rsquo;s root folder. This will install the SwiftShell framework in ~/Library/Frameworks.</li>
<li><em>or</em> run <code>xcodebuild</code> and copy the resulting framework from the build folder to your library folder of choice. If that is not <q>~/Library/Frameworks</q>, <q>/Library/Frameworks</q> or a folder mentioned in the $DYLD_FRAMEWORK_PATH environment variable then you need to add your folder to $DYLD_FRAMEWORK_PATH.</li>
</ul></li>
</ul>
<a href='#license' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h2 id='license'>License</h2>
<p>Released under the MIT License (MIT), <a href="http://opensource.org/licenses/MIT">http://opensource.org/licenses/MIT</a></p>
<p>Some files are covered by other licences, see <a href="Misc/Included%20Works">included works</a>.</p>
<p>Kåre Morstøl, <a href="http://nottoobadsoftware.com">NotTooBad Software</a></p>
</section>
</section>
<section id="footer">
<p>&copy; 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>
+31
View File
@@ -0,0 +1,31 @@
window.jazzy = {'docset': false}
if (typeof window.dash != 'undefined') {
document.documentElement.className += ' dash'
window.jazzy.docset = true
}
if (navigator.userAgent.match(/xcode/i)) {
document.documentElement.className += ' xcode'
window.jazzy.docset = true
}
// On doc load, toggle the URL hash discussion if present
$(document).ready(function() {
if (!window.jazzy.docset) {
var linkToHash = $('a[href="' + window.location.hash +'"]');
linkToHash.trigger("click");
}
});
// On token click, toggle its discussion and animate token.marginLeft
$(".token").click(function() {
if (window.jazzy.docset) {
return;
}
var link = $(this);
var animationDuration = 300;
var tokenOffset = "15px";
var original = link.css('marginLeft') == tokenOffset;
link.animate({'margin-left':original ? "0px" : tokenOffset}, animationDuration);
$content = link.parent().parent().next();
$content.slideToggle(animationDuration);
});
File diff suppressed because one or more lines are too long
@@ -0,0 +1,27 @@
String.swift
public func replace (oldString: String, _ newString: String) -> String
public func split (sep: String) -> [String]
public func trim () -> String
public func countOccurrencesOf (substring: String) -> Int
Pipes.swift
public func |> <T,U> (lhs: T, rhs: T -> U) -> U
FileHandle.swift
public typealias FileHandle = NSFileHandle
public func readSome () -> String?
public func read () -> String
public func lines () -> SequenceOf<String>
public func writeTo <Target : OutputStreamType> (inout target: Target)
public typealias FileHandle = NSFileHandle
public func write (string: String)
public func writeln (string: String)
public func writeln ()
public func closeStream ()
public let environment = NSProcessInfo.processInfo().environment as! [String: String]
public let standardinput = FileHandle.fileHandleWithStandardInput() as ReadableStreamType
public let standardoutput = FileHandle.fileHandleWithStandardOutput() as WriteableStreamType
public let standarderror = FileHandle.fileHandleWithStandardError() as WriteableStreamType
Stream.swift
public var streamencoding = NSUTF8StringEncoding
func write (string: String)
func writeln (string: String)
func writeln ()
Binary file not shown.
BIN
View File
Binary file not shown.
Executable
BIN
View File
Binary file not shown.

After

Width:  |  Height:  |  Size: 274 B

Executable
BIN
View File
Binary file not shown.

After

Width:  |  Height:  |  Size: 1.3 KiB

Executable
BIN
View File
Binary file not shown.

After

Width:  |  Height:  |  Size: 1.5 KiB

+279
View File
@@ -0,0 +1,279 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title> 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=" 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" />
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__">|&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:ZF10SwiftShelloi2ogU___FTQ_FQ_Q0__Q0_">|&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:ZF10SwiftShelloi3oggFTSSPS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:ZF10SwiftShelloi3oggU__FTQ_PS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:ZF10SwiftShelloi3oggUSs12SequenceType_USs13GeneratorType___FTQ_PS_19WriteableStreamType__T_">|&gt;&gt;(_:_:)</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">
<p><em>Updated to <a href="https://developer.apple.com/swift/blog/?id=22">Swift 1.2</a> (Xcode 6.3). <a href="https://github.com/kareman/SwiftShell/releases/tag/v0.1">Use this</a> for earlier versions of Swift (Xcode 6.1.1 and 6.2).</em></p>
<a href='#swiftshell' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h1 id='swiftshell'>SwiftShell</h1>
<p>An OS X Framework for command line scripting in Swift. It supports joining together shell commands and Swift functions, like the pipe in shell commands and the pipe forward operator in F#.</p>
<a href='#usage' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h2 id='usage'>Usage</h2>
<a href='#commands' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h4 id='commands'>Commands</h4>
<p>Shell commands return readable streams, which can be read all at once with <q>read()</q> or read lazily (as in piece by piece) with <q>readSome()</q>. The latter is useful for long texts.</p>
<pre class="highlight swift"><code><span class="cp">#!/usr/bin/env swiftshell</span>
<span class="kd">import</span> <span class="kt">SwiftShell</span>
<span class="k">let</span> <span class="nv">result</span> <span class="o">=</span> <span class="nf">run</span><span class="p">(</span><span class="s">"some shell command"</span><span class="p">)</span><span class="o">.</span><span class="nf">read</span><span class="p">()</span>
</code></pre>
<p>Commands can be piped together:</p>
<pre class="highlight swift"><code><span class="nf">run</span><span class="p">(</span><span class="s">"echo piped to the next command"</span><span class="p">)</span> <span class="o">|&gt;</span> <span class="nf">run</span><span class="p">(</span><span class="s">"wc -w"</span><span class="p">)</span> <span class="o">|&gt;&gt;</span> <span class="n">standardoutput</span>
</code></pre>
<p>Use any sequence as parameters for a command:</p>
<pre class="highlight swift"><code><span class="nf">run</span><span class="p">(</span> <span class="s">"chmod +x"</span> <span class="o">+</span> <span class="nf">parameters</span><span class="p">(</span><span class="n">files</span><span class="p">)</span> <span class="p">)</span>
</code></pre>
<p>For in-line commands, use <code>$(&quot;command&quot;)</code>:</p>
<pre class="highlight swift"><code><span class="nf">print</span><span class="p">(</span> <span class="s">"The time and date is "</span> <span class="o">+</span> <span class="err">$</span><span class="p">(</span><span class="s">"date -u"</span><span class="p">)</span> <span class="p">)</span>
</code></pre>
<a href='#files' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h4 id='files'>Files</h4>
<p>Files are streams too. They can be read line by line:</p>
<pre class="highlight swift"><code><span class="k">for</span> <span class="n">line</span> <span class="k">in</span> <span class="nf">open</span><span class="p">(</span><span class="s">"file1.txt"</span><span class="p">)</span><span class="o">.</span><span class="nf">lines</span><span class="p">()</span> <span class="p">{</span>
<span class="c1">// Do something with each line</span>
<span class="p">}</span>
</code></pre>
<p>Or written to:</p>
<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">file2</span> <span class="o">=</span> <span class="nf">open</span><span class="p">(</span><span class="nv">forWriting</span><span class="p">:</span> <span class="n">tempdirectory</span> <span class="o">/</span> <span class="s">"newfile.txt"</span> <span class="p">)</span>
<span class="nf">run</span><span class="p">(</span><span class="s">"echo line 1"</span><span class="p">)</span> <span class="o">|&gt;&gt;</span> <span class="n">file2</span>
<span class="n">file2</span><span class="o">.</span><span class="nf">writeln</span><span class="p">(</span><span class="s">"line 2"</span><span class="p">)</span>
</code></pre>
<p>And there&rsquo;s easy access to NSFileManager:</p>
<pre class="highlight swift"><code><span class="k">if</span> <span class="kt">File</span><span class="o">.</span><span class="nf">fileExistsAtPath</span><span class="p">(</span><span class="s">"fileiwant.txt"</span><span class="p">)</span> <span class="p">{</span><span class="o">...</span><span class="p">}</span>
<span class="k">if</span> <span class="kt">File</span><span class="o">.</span><span class="nf">isExecutableFileAtPath</span><span class="p">(</span><span class="s">"program"</span><span class="p">)</span> <span class="p">{</span><span class="o">...</span><span class="p">}</span>
<span class="o">...</span>
</code></pre>
<a href='#standard_input' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h4 id='standard_input'>Standard input</h4>
<p>is also a stream:</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">i</span> <span class="o">=</span> <span class="mi">1</span>
<span class="k">for</span> <span class="n">line</span> <span class="k">in</span> <span class="n">standardinput</span><span class="o">.</span><span class="nf">lines</span><span class="p">()</span> <span class="p">{</span>
<span class="nf">print</span><span class="p">(</span><span class="s">"line </span><span class="se">\(</span><span class="n">i</span><span class="o">++</span><span class="se">)</span><span class="s">: "</span><span class="p">)</span>
<span class="nf">println</span><span class="p">(</span><span class="n">line</span><span class="p">)</span>
<span class="p">}</span>
</code></pre>
<p>or</p>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">i</span> <span class="o">=</span> <span class="mi">1</span>
<span class="n">standardinput</span><span class="o">.</span><span class="nf">lines</span><span class="p">()</span> <span class="o">|&gt;</span> <span class="n">map</span> <span class="p">{</span><span class="n">line</span> <span class="k">in</span> <span class="s">"line </span><span class="se">\(</span><span class="n">i</span><span class="o">++</span><span class="se">)</span><span class="s">: </span><span class="se">\(</span><span class="n">line</span><span class="se">)\n</span><span class="s">"</span><span class="p">}</span> <span class="o">|&gt;&gt;</span> <span class="n">standardoutput</span>
</code></pre>
<p>Launch with e.g. <code>ls | print_linenumbers.swift</code></p>
<a href='#examples' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h2 id='examples'>Examples</h2>
<ul>
<li><a href="https://gist.github.com/kareman/322c1091f3cc7e1078af">trash.swift</a>: moves files and folders to the trash.</li>
<li><a href="https://gist.github.com/kareman/d157c46858f91f1a22a7">listallexecutablesinpath.swift</a>: lists all executables currently available in PATH.</li>
</ul>
<a href='#installation' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h2 id='installation'>Installation</h2>
<ul>
<li>In the Terminal, go to where you want to download SwiftShell.</li>
<li><p>Run</p>
<pre class="highlight plaintext"><code>git clone https://github.com/kareman/SwiftShell.git
cd SwiftShell
</code></pre></li>
<li><p>Copy/link <code>Misc/swiftshell</code> to your bin folder or anywhere in your PATH.</p></li>
<li><p>To install the framework itself, either:</p>
<ul>
<li>run <code>xcodebuild install</code> from the project&rsquo;s root folder. This will install the SwiftShell framework in ~/Library/Frameworks.</li>
<li><em>or</em> run <code>xcodebuild</code> and copy the resulting framework from the build folder to your library folder of choice. If that is not <q>~/Library/Frameworks</q>, <q>/Library/Frameworks</q> or a folder mentioned in the $DYLD_FRAMEWORK_PATH environment variable then you need to add your folder to $DYLD_FRAMEWORK_PATH.</li>
</ul></li>
</ul>
<a href='#license' class='anchor' aria-hidden=true><span class="header-anchor"></span></a><h2 id='license'>License</h2>
<p>Released under the MIT License (MIT), <a href="http://opensource.org/licenses/MIT">http://opensource.org/licenses/MIT</a></p>
<p>Some files are covered by other licences, see <a href="Misc/Included%20Works">included works</a>.</p>
<p>Kåre Morstøl, <a href="http://nottoobadsoftware.com">NotTooBad Software</a></p>
</section>
</section>
<section id="footer">
<p>&copy; 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>
Executable
+31
View File
@@ -0,0 +1,31 @@
window.jazzy = {'docset': false}
if (typeof window.dash != 'undefined') {
document.documentElement.className += ' dash'
window.jazzy.docset = true
}
if (navigator.userAgent.match(/xcode/i)) {
document.documentElement.className += ' xcode'
window.jazzy.docset = true
}
// On doc load, toggle the URL hash discussion if present
$(document).ready(function() {
if (!window.jazzy.docset) {
var linkToHash = $('a[href="' + window.location.hash +'"]');
linkToHash.trigger("click");
}
});
// On token click, toggle its discussion and animate token.marginLeft
$(".token").click(function() {
if (window.jazzy.docset) {
return;
}
var link = $(this);
var animationDuration = 300;
var tokenOffset = "15px";
var original = link.css('marginLeft') == tokenOffset;
link.animate({'margin-left':original ? "0px" : tokenOffset}, animationDuration);
$content = link.parent().parent().next();
$content.slideToggle(animationDuration);
});
Vendored Executable
+4
View File
File diff suppressed because one or more lines are too long
+27
View File
@@ -0,0 +1,27 @@
String.swift
public func replace (oldString: String, _ newString: String) -> String
public func split (sep: String) -> [String]
public func trim () -> String
public func countOccurrencesOf (substring: String) -> Int
Pipes.swift
public func |> <T,U> (lhs: T, rhs: T -> U) -> U
FileHandle.swift
public typealias FileHandle = NSFileHandle
public func readSome () -> String?
public func read () -> String
public func lines () -> SequenceOf<String>
public func writeTo <Target : OutputStreamType> (inout target: Target)
public typealias FileHandle = NSFileHandle
public func write (string: String)
public func writeln (string: String)
public func writeln ()
public func closeStream ()
public let environment = NSProcessInfo.processInfo().environment as! [String: String]
public let standardinput = FileHandle.fileHandleWithStandardInput() as ReadableStreamType
public let standardoutput = FileHandle.fileHandleWithStandardOutput() as WriteableStreamType
public let standarderror = FileHandle.fileHandleWithStandardError() as WriteableStreamType
Stream.swift
public var streamencoding = NSUTF8StringEncoding
func write (string: String)
func writeln (string: String)
func writeln ()