407 lines
19 KiB
HTML
407 lines
19 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en">
|
||
<head>
|
||
<title>CustomContext Structure 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/CustomContext" class="dashAnchor"></a>
|
||
<a title="CustomContext Structure 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" />
|
||
CustomContext Structure 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>CustomContext</h1>
|
||
<div class="declaration">
|
||
<div class="language">
|
||
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">CustomContext</span><span class="p">:</span> <span class="kt"><a href="../Protocols/Context.html">Context</a></span><span class="p">,</span> <span class="kt"><a href="../Protocols/CommandRunning.html">CommandRunning</a></span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
<p>Undocumented</p>
|
||
|
||
</section>
|
||
<section class="section task-group-section">
|
||
<div class="task-group">
|
||
<ul>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/s:10SwiftShell13CustomContextV3envs10DictionaryVyS2SGv"></a>
|
||
<a name="//apple_ref/swift/Property/env" class="dashAnchor"></a>
|
||
<a class="token" href="#/s:10SwiftShell13CustomContextV3envs10DictionaryVyS2SGv">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>
|
||
<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">env</span><span class="p">:</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>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/s:10SwiftShell13CustomContextV5stdinAA14ReadableStream_pv"></a>
|
||
<a name="//apple_ref/swift/Property/stdin" class="dashAnchor"></a>
|
||
<a class="token" href="#/s:10SwiftShell13CustomContextV5stdinAA14ReadableStream_pv">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>
|
||
<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">stdin</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:10SwiftShell13CustomContextV6stdoutAA14WritableStream_pv"></a>
|
||
<a name="//apple_ref/swift/Property/stdout" class="dashAnchor"></a>
|
||
<a class="token" href="#/s:10SwiftShell13CustomContextV6stdoutAA14WritableStream_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">var</span> <span class="nv">stdout</span><span class="p">:</span> <span class="kt"><a href="../Protocols/WritableStream.html">WritableStream</a></span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/s:10SwiftShell13CustomContextV8stderrorAA14WritableStream_pv"></a>
|
||
<a name="//apple_ref/swift/Property/stderror" class="dashAnchor"></a>
|
||
<a class="token" href="#/s:10SwiftShell13CustomContextV8stderrorAA14WritableStream_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">var</span> <span class="nv">stderror</span><span class="p">:</span> <span class="kt"><a href="../Protocols/WritableStream.html">WritableStream</a></span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/s:10SwiftShell13CustomContextV16currentdirectorySSv"></a>
|
||
<a name="//apple_ref/swift/Property/currentdirectory" class="dashAnchor"></a>
|
||
<a class="token" href="#/s:10SwiftShell13CustomContextV16currentdirectorySSv">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 swift"><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:10SwiftShell13CustomContextVACycfc"></a>
|
||
<a name="//apple_ref/swift/Method/init()" class="dashAnchor"></a>
|
||
<a class="token" href="#/s:10SwiftShell13CustomContextVACycfc">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 CustomContext where env and stdin are empty, stdout and stderror discard everything and
|
||
currentdirectory is the current working directory.</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="nf">init</span><span class="p">()</span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/s:10SwiftShell13CustomContextVAcA0D0_pcfc"></a>
|
||
<a name="//apple_ref/swift/Method/init(_:)" class="dashAnchor"></a>
|
||
<a class="token" href="#/s:10SwiftShell13CustomContextVAcA0D0_pcfc">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 an identical copy of another Context.</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="nf">init</span><span class="p">(</span><span class="n">_</span> <span class="nv">context</span><span class="p">:</span> <span class="kt"><a href="../Protocols/Context.html">Context</a></span><span class="p">)</span></code></pre>
|
||
|
||
</div>
|
||
</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>
|