363 lines
17 KiB
HTML
363 lines
17 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<title>CustomContext 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/CustomContext" class="dashAnchor"></a>
|
|
<a title="CustomContext Struct 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 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/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/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:v10SwiftShell5FilesCSo11FileManager">Files</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Global Variables.html#/s:v10SwiftShell4mainCS_11MainContext">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/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:F10SwiftShelloi1pFTV10Foundation3URLSS_S1_">+(_:_:)</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Functions.html#/s:F10SwiftShelloi2eeFTOS_12CommandErrorS0__Sb">==(_:_:)</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Functions.html#/s:F10SwiftShell4exitFTPs5Error_4fileSS4lineSi_Os5Never">exit(_:file:line:)</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Functions.html#/s:F10SwiftShell4exiturFT12errormessagex9errorcodeSi4fileSS4lineSi_Os5Never">exit(errormessage:errorcode:file:line:)</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Functions.html#/s:F10SwiftShell4openFzTSS8encodingVE10FoundationSS8Encoding_PS_14ReadableStream_">open(_:encoding:)</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Functions.html#/s:F10SwiftShell4openFzTV10Foundation3URL8encodingVES0_SS8Encoding_PS_14ReadableStream_">open(_:encoding:)</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Functions.html#/s:F10SwiftShell4openFzT10forWritingSS9overwriteSb8encodingVE10FoundationSS8Encoding_PS_14WritableStream_">open(forWriting:overwrite:encoding:)</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Functions.html#/s:F10SwiftShell4openFzT10forWritingV10Foundation3URL9overwriteSb8encodingVES0_SS8Encoding_PS_14WritableStream_">open(forWriting:overwrite:encoding:)</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Functions.html#/s:F10SwiftShell3runFTSSGSaP__13combineOutputSb_CS_9RunOutput">run(_:_:combineOutput:)</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Functions.html#/s:F10SwiftShell3runFT4bashSS13combineOutputSb_CS_9RunOutput">run(bash:combineOutput:)</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_12AsyncCommand">runAsync(_:_:file:line:)</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Functions.html#/s:F10SwiftShell8runAsyncFT4bashSS4fileSS4lineSi_CS_12AsyncCommand">runAsync(bash:file:line:)</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Functions.html#/s:F10SwiftShell7streamsFT_TPS_14WritableStream_PS_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.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">Structs</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>
|
|
<p>Undocumented</p>
|
|
|
|
</section>
|
|
<section class="section task-group-section">
|
|
<div class="task-group">
|
|
<ul>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:vV10SwiftShell13CustomContext3envGVs10DictionarySSSS_"></a>
|
|
<a name="//apple_ref/swift/Property/env" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:vV10SwiftShell13CustomContext3envGVs10DictionarySSSS_">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:vV10SwiftShell13CustomContext5stdinPS_14ReadableStream_"></a>
|
|
<a name="//apple_ref/swift/Property/stdin" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:vV10SwiftShell13CustomContext5stdinPS_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:vV10SwiftShell13CustomContext6stdoutPS_14WritableStream_"></a>
|
|
<a name="//apple_ref/swift/Property/stdout" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:vV10SwiftShell13CustomContext6stdoutPS_14WritableStream_">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:vV10SwiftShell13CustomContext8stderrorPS_14WritableStream_"></a>
|
|
<a name="//apple_ref/swift/Property/stderror" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:vV10SwiftShell13CustomContext8stderrorPS_14WritableStream_">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:vV10SwiftShell13CustomContext16currentdirectorySS"></a>
|
|
<a name="//apple_ref/swift/Property/currentdirectory" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:vV10SwiftShell13CustomContext16currentdirectorySS">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:FV10SwiftShell13CustomContextcFT_S0_"></a>
|
|
<a name="//apple_ref/swift/Method/init()" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FV10SwiftShell13CustomContextcFT_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 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"><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:FV10SwiftShell13CustomContextcFPS_7Context_S0_"></a>
|
|
<a name="//apple_ref/swift/Method/init(_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FV10SwiftShell13CustomContextcFPS_7Context_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 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"><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>© 2017 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2017-04-05)</p>
|
|
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
|
</section>
|
|
</article>
|
|
</div>
|
|
</body>
|
|
</div>
|
|
</html>
|