GitHub/SwiftShell
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Files
f02976b28badc7fc638466a18c498714ebdd11ed
SwiftShell/Extensions.html
T
Kare Morstol f02976b28b 2.0.2 and slightly beyond. 
Docs: add warning about crashing if ‘executable’ is not.
Executable that is.

Make AsyncShellTask a class.
It only contains objects so everything should continue working as before. It is basically a wrapper for NSTask so it should also be a class.

Readme: add section about error handling from commands.

Improve documentation for what "runAndPrint" throws.
2016-03-31 21:57:50 +02:00

327 lines
14 KiB
HTML
Raw Blame History

<!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">SwiftShell Docs</a> (51% documented)</p>
<p class="header-right"><a href="https://github.com/kareman/SwiftShell"><img src="img/gh.png"/>View on GitHub</a></p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="index.html">SwiftShell Reference</a>
<img id="carat" src="img/carat.png" />
Extensions Reference
</p>
</div>
<div class="content-wrapper">
<nav class="sidebar">
<ul class="nav-groups">
<li class="nav-group-name">
<a href="Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Classes/AsyncShellTask.html">AsyncShellTask</a>
</li>
<li class="nav-group-task">
<a href="Classes/MainShellContext.html">MainShellContext</a>
</li>
<li class="nav-group-task">
<a href="Classes/ReadableStream.html">ReadableStream</a>
</li>
<li class="nav-group-task">
<a href="Classes/WriteableStream.html">WriteableStream</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Global Variables.html">Global Variables</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Global Variables.html#/s:v10SwiftShell5FilesCSo13NSFileManager">Files</a>
</li>
<li class="nav-group-task">
<a href="Global Variables.html#/s:v10SwiftShell4mainCS_16MainShellContext">main</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Enums.html">Enums</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Enums/ShellError.html">ShellError</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/CollectionType.html">CollectionType</a>
</li>
<li class="nav-group-task">
<a href="Extensions/LazyCollectionType.html">LazyCollectionType</a>
</li>
<li class="nav-group-task">
<a href="Extensions/NSFileHandle.html">NSFileHandle</a>
</li>
<li class="nav-group-task">
<a href="Extensions/NSTask.html">NSTask</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:ZF10SwiftShelloi1pFTCSo5NSURLSS_S0_">+(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:ZF10SwiftShelloi2eeFTOS_10ShellErrorS0__Sb">==(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:F10SwiftShell4exitFTPs9ErrorType_4fileSS4lineSi_T_">exit(_:file:line:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:F10SwiftShell4exiturFT12errormessagex9errorcodeVs5Int324fileSS4lineSi_T_">exit(errormessage:errorcode:file:line:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:F10SwiftShell4openFzTCSo5NSURL8encodingSu_CS_14ReadableStream">open(_:encoding:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:F10SwiftShell4openFzTSS8encodingSu_CS_14ReadableStream">open(_:encoding:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:F10SwiftShell4openFzT10forWritingSS9overwriteSb8encodingSu_CS_15WriteableStream">open(forWriting:overwrite:encoding:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:F10SwiftShell4openFzT10forWritingCSo5NSURL9overwriteSb8encodingSu_CS_15WriteableStream">open(forWriting:overwrite:encoding:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:F10SwiftShell3runFTSSGSaP__4fileSS4lineSi_SS">run(_:_:file:line:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:F10SwiftShell3runFT4bashSS4fileSS4lineSi_SS">run(bash:file:line:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:F10SwiftShell11runAndPrintFztSSGSaP___T_">runAndPrint(_:_:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:F10SwiftShell11runAndPrintFzT4bashSS_T_">runAndPrint(bash:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:F10SwiftShell8runAsyncFTSSGSaP__4fileSS4lineSi_CS_14AsyncShellTask">runAsync(_:_:file:line:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:F10SwiftShell8runAsyncFT4bashSS_CS_14AsyncShellTask">runAsync(bash:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:F10SwiftShell7streamsFT_TCS_15WriteableStreamCS_14ReadableStream_">streams()</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Protocols/ShellContextType.html">ShellContextType</a>
</li>
<li class="nav-group-task">
<a href="Protocols/ShellRunnable.html">ShellRunnable</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Structs.html">Structs</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Structs/LazySplitSequence.html">LazySplitSequence</a>
</li>
<li class="nav-group-task">
<a href="Structs/PartialSourceLazySplitSequence.html">PartialSourceLazySplitSequence</a>
</li>
<li class="nav-group-task">
<a href="Structs/ShellContext.html">ShellContext</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">
<p>Let Strings run commands using itself as stdin.</p>
<a href="Extensions/String.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><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:Ps14CollectionType"></a>
<a name="//apple_ref/swift/Extension/CollectionType" class="dashAnchor"></a>
<a class="token" href="#/s:Ps14CollectionType">CollectionType</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/CollectionType.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">protocol</span> <span class="kt">CollectionType</span> <span class="p">:</span> <span class="kt">Indexable</span><span class="p">,</span> <span class="kt">SequenceType</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:Ps18LazyCollectionType"></a>
<a name="//apple_ref/swift/Extension/LazyCollectionType" class="dashAnchor"></a>
<a class="token" href="#/s:Ps18LazyCollectionType">LazyCollectionType</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/LazyCollectionType.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">protocol</span> <span class="kt">LazyCollectionType</span> <span class="p">:</span> <span class="kt">CollectionType</span><span class="p">,</span> <span class="kt">LazySequenceType</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<div class="task-name-container">
<a name="/NSTask"></a>
<a name="//apple_ref/swift/Section/NSTask" class="dashAnchor"></a>
<a href="#/NSTask">
<h3 class="section-name">NSTask</h3>
</a>
</div>
<ul>
<li class="item">
<div>
<code>
<a name="/c:objc(cs)NSTask"></a>
<a name="//apple_ref/swift/Extension/NSTask" class="dashAnchor"></a>
<a class="token" href="#/c:objc(cs)NSTask">NSTask</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/NSTask.html" class="slightly-smaller">See more</a>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/c:objc(cs)NSFileHandle"></a>
<a name="//apple_ref/swift/Extension/NSFileHandle" class="dashAnchor"></a>
<a class="token" href="#/c:objc(cs)NSFileHandle">NSFileHandle</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/NSFileHandle.html" class="slightly-smaller">See more</a>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 2016 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2016-03-31)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.5.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</div>
</html>
Reference in New Issue View Git Blame Copy Permalink