387 lines
19 KiB
HTML
387 lines
19 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en">
|
||
<head>
|
||
<title>XcodeLogConfiguration 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/XcodeLogConfiguration" class="dashAnchor"></a>
|
||
<a title="XcodeLogConfiguration Class Reference"></a>
|
||
<header>
|
||
<div class="content-wrapper">
|
||
<p><a href="../index.html">CleanroomLogger Docs</a> (100% documented)</p>
|
||
<p class="header-right"><a href="https://github.com/emaloney/CleanroomLogger"><img src="../img/gh.png"/>View on GitHub</a></p>
|
||
</div>
|
||
</header>
|
||
<div class="content-wrapper">
|
||
<p id="breadcrumbs">
|
||
<a href="../index.html">CleanroomLogger Reference</a>
|
||
<img id="carat" src="../img/carat.png" />
|
||
XcodeLogConfiguration 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/BasicLogConfiguration.html">BasicLogConfiguration</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Classes/BufferedLogEntryMessageRecorder.html">BufferedLogEntryMessageRecorder</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Classes/BufferedLogEntryRecorder.html">BufferedLogEntryRecorder</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Classes/BufferedLogRecorder.html">BufferedLogRecorder</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Classes/BufferedMessageRecorder.html">BufferedMessageRecorder</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Classes/ConcatenatingLogFormatter.html">ConcatenatingLogFormatter</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Classes/ConsoleLogConfiguration.html">ConsoleLogConfiguration</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Classes/ConsoleLogConfiguration/StandardStreamsMode.html">– StandardStreamsMode</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Classes/FieldBasedLogFormatter.html">FieldBasedLogFormatter</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Classes/FieldBasedLogFormatter/Field.html">– Field</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Classes/FileLogRecorder.html">FileLogRecorder</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Classes/LogReceptacle.html">LogReceptacle</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Classes/LogRecorderBase.html">LogRecorderBase</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Classes/OutputStreamLogRecorder.html">OutputStreamLogRecorder</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Classes/ParsableLogFormatter.html">ParsableLogFormatter</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Classes/ReadableLogFormatter.html">ReadableLogFormatter</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Classes/RotatingLogFileConfiguration.html">RotatingLogFileConfiguration</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Classes/RotatingLogFileRecorder.html">RotatingLogFileRecorder</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Classes/StandardErrorLogRecorder.html">StandardErrorLogRecorder</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Classes/StandardLogFormatter.html">StandardLogFormatter</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Classes/StandardOutputLogRecorder.html">StandardOutputLogRecorder</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Classes/StandardStreamsLogRecorder.html">StandardStreamsLogRecorder</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Classes/XcodeLogConfiguration.html">XcodeLogConfiguration</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Classes/XcodeLogFormatter.html">XcodeLogFormatter</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Classes/XcodeTraceLogFormatter.html">XcodeTraceLogFormatter</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/CallingThreadStyle.html">CallingThreadStyle</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Enums/DelimiterStyle.html">DelimiterStyle</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Enums/LogSeverity.html">LogSeverity</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Enums/OSLogTypeTranslator.html">OSLogTypeTranslator</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Enums/SeverityStyle.html">SeverityStyle</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Enums/SeverityStyle/TextRepresentation.html">– TextRepresentation</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Enums/TimestampStyle.html">TimestampStyle</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/LogConfiguration.html">LogConfiguration</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Protocols/LogFilter.html">LogFilter</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Protocols/LogFormatter.html">LogFormatter</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Protocols/LogRecorder.html">LogRecorder</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/CallSiteLogFormatter.html">CallSiteLogFormatter</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Structs/CallingThreadLogFormatter.html">CallingThreadLogFormatter</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Structs/DelimiterLogFormatter.html">DelimiterLogFormatter</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Structs/LiteralLogFormatter.html">LiteralLogFormatter</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Structs/Log.html">Log</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Structs/LogChannel.html">LogChannel</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Structs/LogEntry.html">LogEntry</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Structs/LogEntry/Payload.html">– Payload</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Structs/LogSeverityFilter.html">LogSeverityFilter</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Structs/OSLogRecorder.html">OSLogRecorder</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Structs/PayloadLogFormatter.html">PayloadLogFormatter</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Structs/PayloadMessageLogFormatter.html">PayloadMessageLogFormatter</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Structs/PayloadTraceLogFormatter.html">PayloadTraceLogFormatter</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Structs/PayloadValueLogFormatter.html">PayloadValueLogFormatter</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Structs/ProcessIDLogFormatter.html">ProcessIDLogFormatter</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Structs/ProcessNameLogFormatter.html">ProcessNameLogFormatter</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Structs/SeverityLogFormatter.html">SeverityLogFormatter</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Structs/StackFrameLogFormatter.html">StackFrameLogFormatter</a>
|
||
</li>
|
||
<li class="nav-group-task">
|
||
<a href="../Structs/TimestampLogFormatter.html">TimestampLogFormatter</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</nav>
|
||
<article class="main-content">
|
||
<section>
|
||
<section class="section">
|
||
<h1>XcodeLogConfiguration</h1>
|
||
<div class="declaration">
|
||
<div class="language">
|
||
<pre class="highlight"><code><span class="n">open</span> <span class="kd">class</span> <span class="kt">XcodeLogConfiguration</span><span class="p">:</span> <span class="kt"><a href="../Classes/ConsoleLogConfiguration.html">ConsoleLogConfiguration</a></span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
<p>A <code><a href="../Protocols/LogConfiguration.html">LogConfiguration</a></code> optimized for use when running within Xcode.</p>
|
||
|
||
</section>
|
||
<section class="section task-group-section">
|
||
<div class="task-group">
|
||
<ul>
|
||
<li class="item">
|
||
<div>
|
||
<code>
|
||
<a name="/s:15CleanroomLogger21XcodeLogConfigurationCAcA0D8SeverityO07minimumF0_Sb9debugModeSb012verboseDebugI0AA07ConsoledE0C015StandardStreamsI0O03stdnI0Sb16mimicOSLogOutputSb12showCallSiteSayAA0D6Filter_pG7filterstcfc"></a>
|
||
<a name="//apple_ref/swift/Method/init(minimumSeverity:debugMode:verboseDebugMode:stdStreamsMode:mimicOSLogOutput:showCallSite:filters:)" class="dashAnchor"></a>
|
||
<a class="token" href="#/s:15CleanroomLogger21XcodeLogConfigurationCAcA0D8SeverityO07minimumF0_Sb9debugModeSb012verboseDebugI0AA07ConsoledE0C015StandardStreamsI0O03stdnI0Sb16mimicOSLogOutputSb12showCallSiteSayAA0D6Filter_pG7filterstcfc">init(minimumSeverity:debugMode:verboseDebugMode:stdStreamsMode:mimicOSLogOutput:showCallSite:filters:)</a>
|
||
</code>
|
||
</div>
|
||
<div class="height-container">
|
||
<div class="pointer-container"></div>
|
||
<section class="section">
|
||
<div class="pointer"></div>
|
||
<div class="abstract">
|
||
<p>Initializes a new <code>XcodeLogConfiguration</code> instance.</p>
|
||
<div class="aside aside-warning">
|
||
<p class="aside-title">Warning</p>
|
||
<p>Setting either <code>debugMode</code> or <code>verboseDebugMode</code> to <code>true</code> will
|
||
result in <code>synchronousMode</code> being used when recording log entries.
|
||
Synchronous mode is helpful while debugging, as it ensures that logs are
|
||
always up-to-date when debug breakpoints are hit. However, synchronous
|
||
mode can have a negative influence on performance and is therefore not
|
||
recommended for use in production code.</p>
|
||
|
||
</div>
|
||
|
||
</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="nv">minimumSeverity</span><span class="p">:</span> <span class="kt"><a href="../Enums/LogSeverity.html">LogSeverity</a></span> <span class="o">=</span> <span class="o">.</span><span class="n">info</span><span class="p">,</span> <span class="nv">debugMode</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">false</span><span class="p">,</span> <span class="nv">verboseDebugMode</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">false</span><span class="p">,</span> <span class="nv">stdStreamsMode</span><span class="p">:</span> <span class="kt">StandardStreamsMode</span> <span class="o">=</span> <span class="o">.</span><span class="n">useAsFallback</span><span class="p">,</span> <span class="nv">mimicOSLogOutput</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span><span class="p">,</span> <span class="nv">showCallSite</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">true</span><span class="p">,</span> <span class="nv">filters</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Protocols/LogFilter.html">LogFilter</a></span><span class="p">]</span> <span class="o">=</span> <span class="p">[])</span></code></pre>
|
||
|
||
</div>
|
||
</div>
|
||
<div>
|
||
<h4>Parameters</h4>
|
||
<table class="graybox">
|
||
<tbody>
|
||
<tr>
|
||
<td>
|
||
<code>
|
||
<em>minimumSeverity</em>
|
||
</code>
|
||
</td>
|
||
<td>
|
||
<div>
|
||
<p>The minimum supported <code>LogSeverity</code>. Any
|
||
<code>LogEntry</code> having a <code>severity</code> less than <code>minimumSeverity</code> will be silently
|
||
ignored.</p>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>
|
||
<em>debugMode</em>
|
||
</code>
|
||
</td>
|
||
<td>
|
||
<div>
|
||
<p>If <code>true</code>, the value of <code>minimumSeverity</code> will
|
||
be lowered (if necessary) to <code>.debug</code> and <code>synchronousMode</code> will be used
|
||
when recording log entries.</p>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>
|
||
<em>verboseDebugMode</em>
|
||
</code>
|
||
</td>
|
||
<td>
|
||
<div>
|
||
<p>If <code>true</code>, the value of <code>minimumSeverity</code>
|
||
will be lowered (if necessary) to <code>.verbose</code> and <code>synchronousMode</code> will be
|
||
used when recording log entries.</p>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>
|
||
<em>stdStreamsMode</em>
|
||
</code>
|
||
</td>
|
||
<td>
|
||
<div>
|
||
<p>A <code>StandardStreamsMode</code> value that governs
|
||
when standard console streams (i.e., <code>stdout</code> and <code>stderr</code>) should be used
|
||
for recording log output.</p>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>
|
||
<em>mimicOSLogOutput</em>
|
||
</code>
|
||
</td>
|
||
<td>
|
||
<div>
|
||
<p>If <code>true</code>, any output sent to <code>stdout</code> will
|
||
be formatted in such a way as to mimic the output seen when <code>os_log()</code> is
|
||
used.</p>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>
|
||
<em>showCallSite</em>
|
||
</code>
|
||
</td>
|
||
<td>
|
||
<div>
|
||
<p>If <code>true</code>, the source file and line indicating
|
||
the call site of the log request will be added to formatted log messages.</p>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code>
|
||
<em>filters</em>
|
||
</code>
|
||
</td>
|
||
<td>
|
||
<div>
|
||
<p>The <code>LogFilter</code>s to use when deciding whether a given
|
||
<code>LogEntry</code> should be passed along for recording.</p>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
<section id="footer">
|
||
<p>© 2015-2017 <a class="link" href="http://tech.gilt.com/" target="_blank" rel="external">Gilt Groupe</a></p>
|
||
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
||
</section>
|
||
</article>
|
||
</div>
|
||
</body>
|
||
</div>
|
||
</html>
|