Kare Morstol
f02976b28b
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.
389 lines
17 KiB
HTML
389 lines
17 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<title>ShellContext Struct Reference</title>
|
|
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
|
|
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
|
|
<meta charset='utf-8'>
|
|
<script src="../js/jquery.min.js" defer></script>
|
|
<script src="../js/jazzy.js" defer></script>
|
|
|
|
</head>
|
|
<body>
|
|
<a name="//apple_ref/swift/Struct/ShellContext" class="dashAnchor"></a>
|
|
<a title="ShellContext Struct 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" />
|
|
ShellContext Struct Reference
|
|
</p>
|
|
</div>
|
|
<div class="content-wrapper">
|
|
<nav class="sidebar">
|
|
<ul class="nav-groups">
|
|
<li class="nav-group-name">
|
|
<a href="../Classes.html">Classes</a>
|
|
<ul class="nav-group-tasks">
|
|
<li class="nav-group-task">
|
|
<a href="../Classes/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>ShellContext</h1>
|
|
<p>Undocumented</p>
|
|
|
|
</section>
|
|
<section class="section task-group-section">
|
|
<div class="task-group">
|
|
<ul>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:vV10SwiftShell12ShellContext8encodingSu"></a>
|
|
<a name="//apple_ref/swift/Property/encoding" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:vV10SwiftShell12ShellContext8encodingSu">encoding</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:vV10SwiftShell12ShellContext3envGVs10DictionarySSSS_"></a>
|
|
<a name="//apple_ref/swift/Property/env" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:vV10SwiftShell12ShellContext3envGVs10DictionarySSSS_">env</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:vV10SwiftShell12ShellContext5stdinCS_14ReadableStream"></a>
|
|
<a name="//apple_ref/swift/Property/stdin" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:vV10SwiftShell12ShellContext5stdinCS_14ReadableStream">stdin</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:vV10SwiftShell12ShellContext6stdoutCS_15WriteableStream"></a>
|
|
<a name="//apple_ref/swift/Property/stdout" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:vV10SwiftShell12ShellContext6stdoutCS_15WriteableStream">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>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:vV10SwiftShell12ShellContext8stderrorCS_15WriteableStream"></a>
|
|
<a name="//apple_ref/swift/Property/stderror" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:vV10SwiftShell12ShellContext8stderrorCS_15WriteableStream">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>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:vV10SwiftShell12ShellContext16currentdirectorySS"></a>
|
|
<a name="//apple_ref/swift/Property/currentdirectory" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:vV10SwiftShell12ShellContext16currentdirectorySS">currentdirectory</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("cd", "...")</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>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">currentdirectory</span><span class="p">:</span> <span class="kt">String</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:FV10SwiftShell12ShellContextcFT_S0_"></a>
|
|
<a name="//apple_ref/swift/Method/init()" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FV10SwiftShell12ShellContextcFT_S0_">init()</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Creates a blank ShellContext.</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="nf">init</span> <span class="p">()</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:FV10SwiftShell12ShellContextcFPS_16ShellContextType_S0_"></a>
|
|
<a name="//apple_ref/swift/Method/init(_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FV10SwiftShell12ShellContextcFPS_16ShellContextType_S0_">init(_:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Creates a new ShellContext from another ShellContextType.</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="nf">init</span> <span class="p">(</span><span class="n">_</span> <span class="nv">context</span><span class="p">:</span> <span class="kt">ShellContextType</span><span class="p">)</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="task-group">
|
|
<ul>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:vV10SwiftShell12ShellContext12shellcontextPS_16ShellContextType_"></a>
|
|
<a name="//apple_ref/swift/Property/shellcontext" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:vV10SwiftShell12ShellContext12shellcontextPS_16ShellContextType_">shellcontext</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>© 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>
|