435 lines
20 KiB
HTML
435 lines
20 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en">
|
||
<head>
|
||
<title>AsyncCommand Class 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/Class/AsyncCommand" class="dashAnchor"></a>
|
||
<a title="AsyncCommand Class Reference"></a>
|
||
<header>
|
||
<div class="content-wrapper">
|
||
<p><a href="../index.html">SwiftShell Docs</a> (67% documented)</p>
|
||
<p class="header-right"><a href="https://github.com/kareman/SwiftShell"><img src="../img/gh.png"/>View on GitHub</a></p>
|
||
</div>
|
||
</header>
|
||
<div class="content-wrapper">
|
||
<p id="breadcrumbs">
|
||
<a href="../index.html">SwiftShell Reference</a>
|
||
<img id="carat" src="../img/carat.png" />
|
||
AsyncCommand Class Reference
|
||
</p>
|
||
</div>
|
||
<div class="content-wrapper">
|
||
<nav class="sidebar">
|
||
<ul class="nav-groups">
|
||
<li class="nav-group-name">
|
||
<a href="../Classes.html">Classes</a>
|
||
<ul class="nav-group-tasks">
|
||
<li class="nav-group-task">
|
||
<a href="../Classes/AsyncCommand.html">AsyncCommand</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Classes/FileHandleStream.html">FileHandleStream</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Classes/MainContext.html">MainContext</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Classes/RunOutput.html">RunOutput</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Classes/Signals.html">Signals</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Classes/Signals/Signal.html">– Signal</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Classes/StdoutStream.html">StdoutStream</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="nav-group-name">
|
||
<a href="../Global Variables.html">Global Variables</a>
|
||
<ul class="nav-group-tasks">
|
||
<li class="nav-group-task">
|
||
<a href="../Global Variables.html#/s:10SwiftShell5FilesSo11FileManagerCv">Files</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Global Variables.html#/s:10SwiftShell4mainAA11MainContextCv">main</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="nav-group-name">
|
||
<a href="../Enums.html">Enumerations</a>
|
||
<ul class="nav-group-tasks">
|
||
<li class="nav-group-task">
|
||
<a href="../Enums/CommandError.html">CommandError</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Enums/FileError.html">FileError</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="nav-group-name">
|
||
<a href="../Extensions.html">Extensions</a>
|
||
<ul class="nav-group-tasks">
|
||
<li class="nav-group-task">
|
||
<a href="../Extensions/FileHandle.html">FileHandle</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Extensions/FileHandle.html">FileHandle</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Extensions/LazyCollectionProtocol.html">LazyCollectionProtocol</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Extensions/Process.html">Process</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Extensions/String.html">String</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="nav-group-name">
|
||
<a href="../Functions.html">Functions</a>
|
||
<ul class="nav-group-tasks">
|
||
<li class="nav-group-task">
|
||
<a href="../Functions.html#/s:10SwiftShell1poi10Foundation3URLVAE_SStF">+(_:_:)</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Functions.html#/s:10SwiftShell2eeoiSbAA12CommandErrorO_ADtF">==(_:_:)</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Functions.html#/s:10SwiftShell4exits5NeverOs5Error_p_SS4fileSi4linetF">exit(_:file:line:)</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Functions.html#/s:10SwiftShell4exits5NeverOx12errormessage_Si9errorcodeSS4fileSi4linetlF">exit(errormessage:errorcode:file:line:)</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Functions.html#/s:10SwiftShell4openAA14ReadableStream_p10Foundation3URLV_SSADE8EncodingV8encodingtKF">open(_:encoding:)</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Functions.html#/s:10SwiftShell4openAA14ReadableStream_pSS_SS10FoundationE8EncodingV8encodingtKF">open(_:encoding:)</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Functions.html#/s:10SwiftShell4openAA14WritableStream_p10Foundation3URLV10forWriting_Sb9overwriteSSADE8EncodingV8encodingtKF">open(forWriting:overwrite:encoding:)</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Functions.html#/s:10SwiftShell4openAA14WritableStream_pSS10forWriting_Sb9overwriteSS10FoundationE8EncodingV8encodingtKF">open(forWriting:overwrite:encoding:)</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Functions.html#/s:10SwiftShell3runAA9RunOutputCSS_SayypGdSb07combineE0tF">run(_:_:combineOutput:)</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Functions.html#/s:10SwiftShell3runAA9RunOutputCSS4bash_Sb07combineE0tF">run(bash:combineOutput:)</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Functions.html#/s:10SwiftShell11runAndPrintySS_SayypGdtKF">runAndPrint(_:_:)</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Functions.html#/s:10SwiftShell11runAndPrintySS4bash_tKF">runAndPrint(bash:)</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Functions.html#/s:10SwiftShell8runAsyncAA0D7CommandCSS_SayypGdSS4fileSi4linetF">runAsync(_:_:file:line:)</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Functions.html#/s:10SwiftShell8runAsyncAA0D7CommandCSS4bash_SS4fileSi4linetF">runAsync(bash:file:line:)</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Functions.html#/s:10SwiftShell7streamsAA14WritableStream_p_AA08ReadableE0_ptyF">streams()</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="nav-group-name">
|
||
<a href="../Protocols.html">Protocols</a>
|
||
<ul class="nav-group-tasks">
|
||
<li class="nav-group-task">
|
||
<a href="../Protocols.html#/CommandRunning">CommandRunning</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Protocols/CommandRunning.html">CommandRunning</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Protocols/Context.html">Context</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Protocols/ReadableStream.html">ReadableStream</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Protocols/WritableStream.html">WritableStream</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="nav-group-name">
|
||
<a href="../Structs.html">Structures</a>
|
||
<ul class="nav-group-tasks">
|
||
<li class="nav-group-task">
|
||
<a href="../Structs/CustomContext.html">CustomContext</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Structs/LazySplitSequence.html">LazySplitSequence</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Structs/PartialSourceLazySplitSequence.html">PartialSourceLazySplitSequence</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</nav>
|
||
<article class="main-content">
|
||
<section>
|
||
<section class="section">
|
||
<h1>AsyncCommand</h1>
|
||
<div class="declaration">
|
||
<div class="language">
|
||
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">AsyncCommand</span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
<p>Output from the ‘runAsync’ methods.</p>
|
||
|
||
</section>
|
||
<section class="section task-group-section">
|
||
<div class="task-group">
|
||
<ul>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/s:10SwiftShell12AsyncCommandC6stdoutAA14ReadableStream_pv"></a>
|
||
<a name="//apple_ref/swift/Property/stdout" class="dashAnchor"></a>
|
||
<a class="token" href="#/s:10SwiftShell12AsyncCommandC6stdoutAA14ReadableStream_pv">stdout</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
<p>Undocumented</p>
|
||
|
||
</div>
|
||
<div class="declaration">
|
||
<h4>Declaration</h4>
|
||
<div class="language">
|
||
<p class="aside-title">Swift</p>
|
||
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">stdout</span><span class="p">:</span> <span class="kt"><a href="../Protocols/ReadableStream.html">ReadableStream</a></span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/s:10SwiftShell12AsyncCommandC8stderrorAA14ReadableStream_pv"></a>
|
||
<a name="//apple_ref/swift/Property/stderror" class="dashAnchor"></a>
|
||
<a class="token" href="#/s:10SwiftShell12AsyncCommandC8stderrorAA14ReadableStream_pv">stderror</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
<p>Undocumented</p>
|
||
|
||
</div>
|
||
<div class="declaration">
|
||
<h4>Declaration</h4>
|
||
<div class="language">
|
||
<p class="aside-title">Swift</p>
|
||
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">stderror</span><span class="p">:</span> <span class="kt"><a href="../Protocols/ReadableStream.html">ReadableStream</a></span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/s:10SwiftShell12AsyncCommandC9isRunningSbv"></a>
|
||
<a name="//apple_ref/swift/Property/isRunning" class="dashAnchor"></a>
|
||
<a class="token" href="#/s:10SwiftShell12AsyncCommandC9isRunningSbv">isRunning</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
<p>Is the command still running?</p>
|
||
|
||
</div>
|
||
<div class="declaration">
|
||
<h4>Declaration</h4>
|
||
<div class="language">
|
||
<p class="aside-title">Swift</p>
|
||
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isRunning</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/s:10SwiftShell12AsyncCommandC4stopyyF"></a>
|
||
<a name="//apple_ref/swift/Method/stop()" class="dashAnchor"></a>
|
||
<a class="token" href="#/s:10SwiftShell12AsyncCommandC4stopyyF">stop()</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
<p>Terminates command.</p>
|
||
|
||
</div>
|
||
<div class="declaration">
|
||
<h4>Declaration</h4>
|
||
<div class="language">
|
||
<p class="aside-title">Swift</p>
|
||
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">stop</span><span class="p">()</span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/s:10SwiftShell12AsyncCommandC6finishACyKF"></a>
|
||
<a name="//apple_ref/swift/Method/finish()" class="dashAnchor"></a>
|
||
<a class="token" href="#/s:10SwiftShell12AsyncCommandC6finishACyKF">finish()</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
<p>Wait for this command to finish.</p>
|
||
<div class="aside aside-throws">
|
||
<p class="aside-title">Throws</p>
|
||
<code>CommandError.returnedErrorCode(command: String, errorcode: Int)</code> if the exit code is anything but 0.
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<div class="declaration">
|
||
<h4>Declaration</h4>
|
||
<div class="language">
|
||
<p class="aside-title">Swift</p>
|
||
<pre class="highlight swift"><code><span class="kd">@discardableResult</span> <span class="kd">public</span> <span class="kd">func</span> <span class="nf">finish</span><span class="p">()</span> <span class="k">throws</span> <span class="o">-></span> <span class="kt">AsyncCommand</span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
<div>
|
||
<h4>Return Value</h4>
|
||
<p>itself</p>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/s:10SwiftShell12AsyncCommandC8exitcodeSiyF"></a>
|
||
<a name="//apple_ref/swift/Method/exitcode()" class="dashAnchor"></a>
|
||
<a class="token" href="#/s:10SwiftShell12AsyncCommandC8exitcodeSiyF">exitcode()</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
<p>Wait for command to finish, then return with exit code.</p>
|
||
|
||
</div>
|
||
<div class="declaration">
|
||
<h4>Declaration</h4>
|
||
<div class="language">
|
||
<p class="aside-title">Swift</p>
|
||
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">exitcode</span><span class="p">()</span> <span class="o">-></span> <span class="kt">Int</span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/s:10SwiftShell12AsyncCommandC12onCompletionACyACcF"></a>
|
||
<a name="//apple_ref/swift/Method/onCompletion(_:)" class="dashAnchor"></a>
|
||
<a class="token" href="#/s:10SwiftShell12AsyncCommandC12onCompletionACyACcF">onCompletion(_:)</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
<p>Takes a closure to be called when the command has finished.</p>
|
||
|
||
</div>
|
||
<div class="declaration">
|
||
<h4>Declaration</h4>
|
||
<div class="language">
|
||
<p class="aside-title">Swift</p>
|
||
<pre class="highlight swift"><code><span class="kd">@discardableResult</span> <span class="kd">public</span> <span class="kd">func</span> <span class="nf">onCompletion</span><span class="p">(</span><span class="n">_</span> <span class="nv">handler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt">AsyncCommand</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-></span> <span class="kt">AsyncCommand</span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
<div>
|
||
<h4>Parameters</h4>
|
||
<table class="graybox">
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>
|
||
<em>handler</em>
|
||
</code>
|
||
</td>
|
||
<td>
|
||
<div>
|
||
<p>A closure taking this AsyncCommand as input, returning nothing.</p>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div>
|
||
<h4>Return Value</h4>
|
||
<p>This AsyncCommand.</p>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
<section id="footer">
|
||
<p>© 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-01-30)</p>
|
||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||
</section>
|
||
</article>
|
||
</div>
|
||
</body>
|
||
</div>
|
||
</html>
|