mirror
/
swift-metrics
mirror of https://github.com/apple/swift-metrics.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

publish 0.0.0 docs

This commit is contained in:
tomer doron 2019-04-22 16:49:17 +00:00
parent deb06d4d33
commit be00d01a8b
42 changed files with 920 additions and 92 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/0.0.0/CoreMetrics/Classes.html
View File

@ -23,7 +23,7 @@
<a class="header-link" href="index.html">
CoreMetrics Docs
</a>
(85% documented)
(88% documented)
</p>
<p class="header-col--secondary">
@ -297,7 +297,7 @@ This is the user facing Timer API. Its behavior depends on the <code><a href="Pr
</article>
</div>
<section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-10)</p>
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>

33
docs/0.0.0/CoreMetrics/Classes/Counter.html
View File

@ -23,7 +23,7 @@
<a class="header-link" href="../index.html">
CoreMetrics Docs
</a>
(85% documented)
(88% documented)
</p>
<p class="header-col--secondary">
@ -414,6 +414,35 @@ we do not expect this API to be used in normal circumstances, so if you find you
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11CoreMetrics7CounterC7destroyyyF"></a>
<a name="//apple_ref/swift/Method/destroy()" class="dashAnchor"></a>
<a class="token" href="#/s:11CoreMetrics7CounterC7destroyyyF">destroy()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Signal the underlying metrics library that this counter will never be updated again.
In response library MAY decide to eagerly release any resources held by this counter.</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">@inlinable</span>
<span class="kd">func</span> <span class="nf">destroy</span><span class="p">()</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
@ -422,7 +451,7 @@ we do not expect this API to be used in normal circumstances, so if you find you
</article>
</div>
<section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-10)</p>
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>

4
docs/0.0.0/CoreMetrics/Classes/Gauge.html
View File

@ -23,7 +23,7 @@
<a class="header-link" href="../index.html">
CoreMetrics Docs
</a>
(85% documented)
(88% documented)
</p>
<p class="header-col--secondary">
@ -188,7 +188,7 @@ Gauges are modeled as <code><a href="../Classes/Recorder.html">Recorder</a></cod
</article>
</div>
<section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-10)</p>
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>

82
docs/0.0.0/CoreMetrics/Classes/MultiplexMetricsHandler.html
View File

@ -23,7 +23,7 @@
<a class="header-link" href="../index.html">
CoreMetrics Docs
</a>
(85% documented)
(88% documented)
</p>
<p class="header-col--secondary">
@ -225,6 +225,84 @@
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11CoreMetrics0B7FactoryP14destroyCounteryyAA0E7Handler_pF"></a>
<a name="//apple_ref/swift/Method/destroyCounter(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:11CoreMetrics0B7FactoryP14destroyCounteryyAA0E7Handler_pF">destroyCounter(_:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
</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">destroyCounter</span><span class="p">(</span><span class="n">_</span> <span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Protocols/CounterHandler.html">CounterHandler</a></span><span class="p">)</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11CoreMetrics0B7FactoryP15destroyRecorderyyAA0E7Handler_pF"></a>
<a name="//apple_ref/swift/Method/destroyRecorder(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:11CoreMetrics0B7FactoryP15destroyRecorderyyAA0E7Handler_pF">destroyRecorder(_:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
</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">destroyRecorder</span><span class="p">(</span><span class="n">_</span> <span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RecorderHandler.html">RecorderHandler</a></span><span class="p">)</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11CoreMetrics0B7FactoryP12destroyTimeryyAA0E7Handler_pF"></a>
<a name="//apple_ref/swift/Method/destroyTimer(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:11CoreMetrics0B7FactoryP12destroyTimeryyAA0E7Handler_pF">destroyTimer(_:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
</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">destroyTimer</span><span class="p">(</span><span class="n">_</span> <span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Protocols/TimerHandler.html">TimerHandler</a></span><span class="p">)</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
@ -233,7 +311,7 @@
</article>
</div>
<section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-10)</p>
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>

82
docs/0.0.0/CoreMetrics/Classes/NOOPMetricsHandler.html
View File

@ -23,7 +23,7 @@
<a class="header-link" href="../index.html">
CoreMetrics Docs
</a>
(85% documented)
(88% documented)
</p>
<p class="header-col--secondary">
@ -225,6 +225,84 @@
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11CoreMetrics0B7FactoryP14destroyCounteryyAA0E7Handler_pF"></a>
<a name="//apple_ref/swift/Method/destroyCounter(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:11CoreMetrics0B7FactoryP14destroyCounteryyAA0E7Handler_pF">destroyCounter(_:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
</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">destroyCounter</span><span class="p">(</span><span class="n">_</span> <span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Protocols/CounterHandler.html">CounterHandler</a></span><span class="p">)</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11CoreMetrics0B7FactoryP15destroyRecorderyyAA0E7Handler_pF"></a>
<a name="//apple_ref/swift/Method/destroyRecorder(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:11CoreMetrics0B7FactoryP15destroyRecorderyyAA0E7Handler_pF">destroyRecorder(_:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
</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">destroyRecorder</span><span class="p">(</span><span class="n">_</span> <span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RecorderHandler.html">RecorderHandler</a></span><span class="p">)</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11CoreMetrics0B7FactoryP12destroyTimeryyAA0E7Handler_pF"></a>
<a name="//apple_ref/swift/Method/destroyTimer(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:11CoreMetrics0B7FactoryP12destroyTimeryyAA0E7Handler_pF">destroyTimer(_:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
</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">destroyTimer</span><span class="p">(</span><span class="n">_</span> <span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Protocols/TimerHandler.html">TimerHandler</a></span><span class="p">)</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
@ -363,7 +441,7 @@
</article>
</div>
<section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-10)</p>
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>

33
docs/0.0.0/CoreMetrics/Classes/Recorder.html
View File

@ -23,7 +23,7 @@
<a class="header-link" href="../index.html">
CoreMetrics Docs
</a>
(85% documented)
(88% documented)
</p>
<p class="header-col--secondary">
@ -431,6 +431,35 @@ we do not expect this API to be used in normal circumstances, so if you find you
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11CoreMetrics8RecorderC7destroyyyF"></a>
<a name="//apple_ref/swift/Method/destroy()" class="dashAnchor"></a>
<a class="token" href="#/s:11CoreMetrics8RecorderC7destroyyyF">destroy()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Signal the underlying metrics library that this recorder will never be updated again.
In response library MAY decide to eagerly release any resources held by this recorder.</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">@inlinable</span>
<span class="kd">func</span> <span class="nf">destroy</span><span class="p">()</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
@ -439,7 +468,7 @@ we do not expect this API to be used in normal circumstances, so if you find you
</article>
</div>
<section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-10)</p>
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>

33
docs/0.0.0/CoreMetrics/Classes/Timer.html
View File

@ -23,7 +23,7 @@
<a class="header-link" href="../index.html">
CoreMetrics Docs
</a>
(85% documented)
(88% documented)
</p>
<p class="header-col--secondary">
@ -640,6 +640,35 @@ we do not expect this API to be used in normal circumstances, so if you find you
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11CoreMetrics5TimerC7destroyyyF"></a>
<a name="//apple_ref/swift/Method/destroy()" class="dashAnchor"></a>
<a class="token" href="#/s:11CoreMetrics5TimerC7destroyyyF">destroy()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Signal the underlying metrics library that this timer will never be updated again.
In response library MAY decide to eagerly release any resources held by this timer.</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">@inlinable</span>
<span class="kd">func</span> <span class="nf">destroy</span><span class="p">()</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
@ -648,7 +677,7 @@ we do not expect this API to be used in normal circumstances, so if you find you
</article>
</div>
<section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-10)</p>
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>

4
docs/0.0.0/CoreMetrics/Enums.html
View File

@ -23,7 +23,7 @@
<a class="header-link" href="index.html">
CoreMetrics Docs
</a>
(85% documented)
(88% documented)
</p>
<p class="header-col--secondary">
@ -152,7 +152,7 @@ implementation.</p>
</article>
</div>
<section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-10)</p>
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>

6
docs/0.0.0/CoreMetrics/Enums/MetricsSystem.html
View File

@ -23,7 +23,7 @@
<a class="header-link" href="../index.html">
CoreMetrics Docs
</a>
(85% documented)
(88% documented)
</p>
<p class="header-col--secondary">
@ -183,7 +183,7 @@ lead to undefined behaviour, most likely a crash.</p>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Returns a refernece to the configured factory.</p>
<p>Returns a reference to the configured factory.</p>
</div>
<div class="declaration">
@ -205,7 +205,7 @@ lead to undefined behaviour, most likely a crash.</p>
</article>
</div>
<section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-10)</p>
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>

19
docs/0.0.0/CoreMetrics/Protocols.html
View File

@ -23,7 +23,7 @@
<a class="header-link" href="index.html">
CoreMetrics Docs
</a>
(85% documented)
(88% documented)
</p>
<p class="header-col--secondary">
@ -255,6 +255,21 @@ as expected regardless of the selected <code>TimerHandler</code> implementation.
<p>This type is an implementation detail and should not be used directly, unless implementing your own metrics backend.
To use the SwiftMetrics API, please refer to the documentation of <code><a href="Enums/MetricsSystem.html">MetricsSystem</a></code>.</p>
<h1 id='destroying-metrics' class='heading'>Destroying metrics</h1>
<p>Since <em>some</em> metrics implementations may need to allocate (potentially <q>heavy</q>) resources for metrics, destroying
metrics offers a signal to libraries when a metric is <q>known to never be updated again.</q></p>
<p>While many metrics are bound to the entire lifetime of an application and thus never need to be destroyed eagerly,
some metrics have well defined unique life-cycles, and it may be beneficial to release any resources held by them
more eagerly than awaiting the applications termination. In such cases, a library or application should invoke
a metric&rsquo;s appropriate <code>destroy()</code> method, which in turn results in the corresponding handler that it is backed by
to be passed to <code>destroyCounter(handler:)</code>, <code>destroyRecorder(handler:)</code> or <code>destroyTimer(handler:)</code> where the factory
can decide to free any corresponding resources.</p>
<p>While some libraries may not need to implement this destroying as they may be stateless or similar,
libraries using the metrics API should always assume a library WILL make use of this signal, and shall not
neglect calling these methods when appropriate.</p>
<a href="Protocols/MetricsFactory.html" class="slightly-smaller">See more</a>
</div>
@ -277,7 +292,7 @@ To use the SwiftMetrics API, please refer to the documentation of <code><a href=
</article>
</div>
<section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-10)</p>
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>

4
docs/0.0.0/CoreMetrics/Protocols/CounterHandler.html
View File

@ -23,7 +23,7 @@
<a class="header-link" href="../index.html">
CoreMetrics Docs
</a>
(85% documented)
(88% documented)
</p>
<p class="header-col--secondary">
@ -212,7 +212,7 @@ as expected regardless of the selected <code>CounterHandler</code> implementatio
</article>
</div>
<section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-10)</p>
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>

160
docs/0.0.0/CoreMetrics/Protocols/MetricsFactory.html
View File

@ -23,7 +23,7 @@
<a class="header-link" href="../index.html">
CoreMetrics Docs
</a>
(85% documented)
(88% documented)
</p>
<p class="header-col--secondary">
@ -122,6 +122,21 @@
<p>This type is an implementation detail and should not be used directly, unless implementing your own metrics backend.
To use the SwiftMetrics API, please refer to the documentation of <code><a href="../Enums/MetricsSystem.html">MetricsSystem</a></code>.</p>
<h1 id='destroying-metrics' class='heading'>Destroying metrics</h1>
<p>Since <em>some</em> metrics implementations may need to allocate (potentially <q>heavy</q>) resources for metrics, destroying
metrics offers a signal to libraries when a metric is <q>known to never be updated again.</q></p>
<p>While many metrics are bound to the entire lifetime of an application and thus never need to be destroyed eagerly,
some metrics have well defined unique life-cycles, and it may be beneficial to release any resources held by them
more eagerly than awaiting the applications termination. In such cases, a library or application should invoke
a metric&rsquo;s appropriate <code>destroy()</code> method, which in turn results in the corresponding handler that it is backed by
to be passed to <code>destroyCounter(handler:)</code>, <code>destroyRecorder(handler:)</code> or <code>destroyTimer(handler:)</code> where the factory
can decide to free any corresponding resources.</p>
<p>While some libraries may not need to implement this destroying as they may be stateless or similar,
libraries using the metrics API should always assume a library WILL make use of this signal, and shall not
neglect calling these methods when appropriate.</p>
</div>
</section>
@ -316,6 +331,147 @@ To use the SwiftMetrics API, please refer to the documentation of <code><a href=
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11CoreMetrics0B7FactoryP14destroyCounteryyAA0E7Handler_pF"></a>
<a name="//apple_ref/swift/Method/destroyCounter(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:11CoreMetrics0B7FactoryP14destroyCounteryyAA0E7Handler_pF">destroyCounter(_:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Invoked when the corresponding <code><a href="../Classes/Counter.html">Counter</a></code>&lsquo;s <code>destroy()</code> function is invoked.
Upon receiving this signal the factory may eagerly release any resources related to this counter.</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">func</span> <span class="nf">destroyCounter</span><span class="p">(</span><span class="n">_</span> <span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Protocols/CounterHandler.html">CounterHandler</a></span><span class="p">)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>handler</em>
</code>
</td>
<td>
<div>
<p>The handler to be destroyed.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11CoreMetrics0B7FactoryP15destroyRecorderyyAA0E7Handler_pF"></a>
<a name="//apple_ref/swift/Method/destroyRecorder(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:11CoreMetrics0B7FactoryP15destroyRecorderyyAA0E7Handler_pF">destroyRecorder(_:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Invoked when the corresponding <code><a href="../Classes/Recorder.html">Recorder</a></code>&lsquo;s <code>destroy()</code> function is invoked.
Upon receiving this signal the factory may eagerly release any resources related to this recorder.</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">func</span> <span class="nf">destroyRecorder</span><span class="p">(</span><span class="n">_</span> <span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RecorderHandler.html">RecorderHandler</a></span><span class="p">)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>handler</em>
</code>
</td>
<td>
<div>
<p>The handler to be destroyed.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11CoreMetrics0B7FactoryP12destroyTimeryyAA0E7Handler_pF"></a>
<a name="//apple_ref/swift/Method/destroyTimer(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:11CoreMetrics0B7FactoryP12destroyTimeryyAA0E7Handler_pF">destroyTimer(_:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Invoked when the corresponding <code><a href="../Classes/Timer.html">Timer</a></code>&lsquo;s <code>destroy()</code> function is invoked.
Upon receiving this signal the factory may eagerly release any resources related to this timer.</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">func</span> <span class="nf">destroyTimer</span><span class="p">(</span><span class="n">_</span> <span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Protocols/TimerHandler.html">TimerHandler</a></span><span class="p">)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>handler</em>
</code>
</td>
<td>
<div>
<p>The handler to be destroyed.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
@ -324,7 +480,7 @@ To use the SwiftMetrics API, please refer to the documentation of <code><a href=
</article>
</div>
<section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-10)</p>
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>

4
docs/0.0.0/CoreMetrics/Protocols/RecorderHandler.html
View File

@ -23,7 +23,7 @@
<a class="header-link" href="../index.html">
CoreMetrics Docs
</a>
(85% documented)
(88% documented)
</p>
<p class="header-col--secondary">
@ -231,7 +231,7 @@ as expected regardless of the selected <code>RecorderHandler</code> implementati
</article>
</div>
<section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-10)</p>
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>

4
docs/0.0.0/CoreMetrics/Protocols/TimerHandler.html
View File

@ -23,7 +23,7 @@
<a class="header-link" href="../index.html">
CoreMetrics Docs
</a>
(85% documented)
(88% documented)
</p>
<p class="header-col--secondary">
@ -185,7 +185,7 @@ as expected regardless of the selected <code>TimerHandler</code> implementation.
</article>
</div>
<section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-10)</p>
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>

4
docs/0.0.0/CoreMetrics/badge.svg
View File

@ -19,10 +19,10 @@
documentation
</text>
<text x="1095" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="250">
85%
88%
</text>
<text x="1095" y="140" transform="scale(.1)" textLength="250">
85%
88%
</text>
</g>
</svg>

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 1.1 KiB

After

Width:  |  Height:  |  Size: 1.1 KiB

4
docs/0.0.0/CoreMetrics/index.html
View File

@ -22,7 +22,7 @@
<a class="header-link" href="index.html">
CoreMetrics Docs
</a>
(85% documented)
(88% documented)
</p>
<p class="header-col--secondary">
@ -131,7 +131,7 @@
</article>
</div>
<section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-10)</p>
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>

2
docs/0.0.0/CoreMetrics/search.json
View File

File diff suppressed because one or more lines are too long

18
docs/0.0.0/CoreMetrics/undocumented.json
View File

@ -2,63 +2,63 @@
"warnings": [
{
"file": "/code/Sources/CoreMetrics/Metrics.swift",
"line": 42,
"line": 43,
"symbol": "Counter.label",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
"file": "/code/Sources/CoreMetrics/Metrics.swift",
"line": 43,
"line": 44,
"symbol": "Counter.dimensions",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
"file": "/code/Sources/CoreMetrics/Metrics.swift",
"line": 123,
"line": 132,
"symbol": "Recorder.label",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
"file": "/code/Sources/CoreMetrics/Metrics.swift",
"line": 124,
"line": 133,
"symbol": "Recorder.dimensions",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
"file": "/code/Sources/CoreMetrics/Metrics.swift",
"line": 125,
"line": 134,
"symbol": "Recorder.aggregate",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
"file": "/code/Sources/CoreMetrics/Metrics.swift",
"line": 213,
"line": 229,
"symbol": "Timer.label",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
"file": "/code/Sources/CoreMetrics/Metrics.swift",
"line": 214,
"line": 230,
"symbol": "Timer.dimensions",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
"file": "/code/Sources/CoreMetrics/Metrics.swift",
"line": 375,
"line": 452,
"symbol": "MultiplexMetricsHandler.init(factories:)",
"symbol_kind": "source.lang.swift.decl.function.method.instance",
"warning": "undocumented"
},
{
"file": "/code/Sources/CoreMetrics/Metrics.swift",
"line": 435,
"line": 532,
"symbol": "NOOPMetricsHandler.instance",
"symbol_kind": "source.lang.swift.decl.var.static",
"warning": "undocumented"

2
docs/0.0.0/Metrics/Extensions.html
View File

@ -109,7 +109,7 @@
</article>
</div>
<section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-10)</p>
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>

2
docs/0.0.0/Metrics/Extensions/Timer.html
View File

@ -256,7 +256,7 @@
</article>
</div>
<section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-10)</p>
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>

2
docs/0.0.0/Metrics/index.html
View File

@ -91,7 +91,7 @@
</article>
</div>
<section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-10)</p>
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>

4
docs/current/CoreMetrics/Classes.html
View File

@ -23,7 +23,7 @@
<a class="header-link" href="index.html">
CoreMetrics Docs
</a>
(85% documented)
(88% documented)
</p>
<p class="header-col--secondary">
@ -297,7 +297,7 @@ This is the user facing Timer API. Its behavior depends on the <code><a href="Pr
</article>
</div>
<section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-10)</p>
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>

33
docs/current/CoreMetrics/Classes/Counter.html
View File

@ -23,7 +23,7 @@
<a class="header-link" href="../index.html">
CoreMetrics Docs
</a>
(85% documented)
(88% documented)
</p>
<p class="header-col--secondary">
@ -414,6 +414,35 @@ we do not expect this API to be used in normal circumstances, so if you find you
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11CoreMetrics7CounterC7destroyyyF"></a>
<a name="//apple_ref/swift/Method/destroy()" class="dashAnchor"></a>
<a class="token" href="#/s:11CoreMetrics7CounterC7destroyyyF">destroy()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Signal the underlying metrics library that this counter will never be updated again.
In response library MAY decide to eagerly release any resources held by this counter.</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">@inlinable</span>
<span class="kd">func</span> <span class="nf">destroy</span><span class="p">()</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
@ -422,7 +451,7 @@ we do not expect this API to be used in normal circumstances, so if you find you
</article>
</div>
<section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-10)</p>
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>

4
docs/current/CoreMetrics/Classes/Gauge.html
View File

@ -23,7 +23,7 @@
<a class="header-link" href="../index.html">
CoreMetrics Docs
</a>
(85% documented)
(88% documented)
</p>
<p class="header-col--secondary">
@ -188,7 +188,7 @@ Gauges are modeled as <code><a href="../Classes/Recorder.html">Recorder</a></cod
</article>
</div>
<section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-10)</p>
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>

82
docs/current/CoreMetrics/Classes/MultiplexMetricsHandler.html
View File

@ -23,7 +23,7 @@
<a class="header-link" href="../index.html">
CoreMetrics Docs
</a>
(85% documented)
(88% documented)
</p>
<p class="header-col--secondary">
@ -225,6 +225,84 @@
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11CoreMetrics0B7FactoryP14destroyCounteryyAA0E7Handler_pF"></a>
<a name="//apple_ref/swift/Method/destroyCounter(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:11CoreMetrics0B7FactoryP14destroyCounteryyAA0E7Handler_pF">destroyCounter(_:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
</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">destroyCounter</span><span class="p">(</span><span class="n">_</span> <span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Protocols/CounterHandler.html">CounterHandler</a></span><span class="p">)</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11CoreMetrics0B7FactoryP15destroyRecorderyyAA0E7Handler_pF"></a>
<a name="//apple_ref/swift/Method/destroyRecorder(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:11CoreMetrics0B7FactoryP15destroyRecorderyyAA0E7Handler_pF">destroyRecorder(_:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
</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">destroyRecorder</span><span class="p">(</span><span class="n">_</span> <span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RecorderHandler.html">RecorderHandler</a></span><span class="p">)</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11CoreMetrics0B7FactoryP12destroyTimeryyAA0E7Handler_pF"></a>
<a name="//apple_ref/swift/Method/destroyTimer(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:11CoreMetrics0B7FactoryP12destroyTimeryyAA0E7Handler_pF">destroyTimer(_:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
</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">destroyTimer</span><span class="p">(</span><span class="n">_</span> <span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Protocols/TimerHandler.html">TimerHandler</a></span><span class="p">)</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
@ -233,7 +311,7 @@
</article>
</div>
<section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-10)</p>
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>

82
docs/current/CoreMetrics/Classes/NOOPMetricsHandler.html
View File

@ -23,7 +23,7 @@
<a class="header-link" href="../index.html">
CoreMetrics Docs
</a>
(85% documented)
(88% documented)
</p>
<p class="header-col--secondary">
@ -225,6 +225,84 @@
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11CoreMetrics0B7FactoryP14destroyCounteryyAA0E7Handler_pF"></a>
<a name="//apple_ref/swift/Method/destroyCounter(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:11CoreMetrics0B7FactoryP14destroyCounteryyAA0E7Handler_pF">destroyCounter(_:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
</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">destroyCounter</span><span class="p">(</span><span class="n">_</span> <span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Protocols/CounterHandler.html">CounterHandler</a></span><span class="p">)</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11CoreMetrics0B7FactoryP15destroyRecorderyyAA0E7Handler_pF"></a>
<a name="//apple_ref/swift/Method/destroyRecorder(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:11CoreMetrics0B7FactoryP15destroyRecorderyyAA0E7Handler_pF">destroyRecorder(_:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
</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">destroyRecorder</span><span class="p">(</span><span class="n">_</span> <span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RecorderHandler.html">RecorderHandler</a></span><span class="p">)</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11CoreMetrics0B7FactoryP12destroyTimeryyAA0E7Handler_pF"></a>
<a name="//apple_ref/swift/Method/destroyTimer(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:11CoreMetrics0B7FactoryP12destroyTimeryyAA0E7Handler_pF">destroyTimer(_:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
</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">destroyTimer</span><span class="p">(</span><span class="n">_</span> <span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Protocols/TimerHandler.html">TimerHandler</a></span><span class="p">)</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
@ -363,7 +441,7 @@
</article>
</div>
<section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-10)</p>
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>

33
docs/current/CoreMetrics/Classes/Recorder.html
View File

@ -23,7 +23,7 @@
<a class="header-link" href="../index.html">
CoreMetrics Docs
</a>
(85% documented)
(88% documented)
</p>
<p class="header-col--secondary">
@ -431,6 +431,35 @@ we do not expect this API to be used in normal circumstances, so if you find you
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11CoreMetrics8RecorderC7destroyyyF"></a>
<a name="//apple_ref/swift/Method/destroy()" class="dashAnchor"></a>
<a class="token" href="#/s:11CoreMetrics8RecorderC7destroyyyF">destroy()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Signal the underlying metrics library that this recorder will never be updated again.
In response library MAY decide to eagerly release any resources held by this recorder.</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">@inlinable</span>
<span class="kd">func</span> <span class="nf">destroy</span><span class="p">()</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
@ -439,7 +468,7 @@ we do not expect this API to be used in normal circumstances, so if you find you
</article>
</div>
<section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-10)</p>
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>

33
docs/current/CoreMetrics/Classes/Timer.html
View File

@ -23,7 +23,7 @@
<a class="header-link" href="../index.html">
CoreMetrics Docs
</a>
(85% documented)
(88% documented)
</p>
<p class="header-col--secondary">
@ -640,6 +640,35 @@ we do not expect this API to be used in normal circumstances, so if you find you
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11CoreMetrics5TimerC7destroyyyF"></a>
<a name="//apple_ref/swift/Method/destroy()" class="dashAnchor"></a>
<a class="token" href="#/s:11CoreMetrics5TimerC7destroyyyF">destroy()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Signal the underlying metrics library that this timer will never be updated again.
In response library MAY decide to eagerly release any resources held by this timer.</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">@inlinable</span>
<span class="kd">func</span> <span class="nf">destroy</span><span class="p">()</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
@ -648,7 +677,7 @@ we do not expect this API to be used in normal circumstances, so if you find you
</article>
</div>
<section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-10)</p>
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>

4
docs/current/CoreMetrics/Enums.html
View File

@ -23,7 +23,7 @@
<a class="header-link" href="index.html">
CoreMetrics Docs
</a>
(85% documented)
(88% documented)
</p>
<p class="header-col--secondary">
@ -152,7 +152,7 @@ implementation.</p>
</article>
</div>
<section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-10)</p>
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>

6
docs/current/CoreMetrics/Enums/MetricsSystem.html
View File

@ -23,7 +23,7 @@
<a class="header-link" href="../index.html">
CoreMetrics Docs
</a>
(85% documented)
(88% documented)
</p>
<p class="header-col--secondary">
@ -183,7 +183,7 @@ lead to undefined behaviour, most likely a crash.</p>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Returns a refernece to the configured factory.</p>
<p>Returns a reference to the configured factory.</p>
</div>
<div class="declaration">
@ -205,7 +205,7 @@ lead to undefined behaviour, most likely a crash.</p>
</article>
</div>
<section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-10)</p>
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>

19
docs/current/CoreMetrics/Protocols.html
View File

@ -23,7 +23,7 @@
<a class="header-link" href="index.html">
CoreMetrics Docs
</a>
(85% documented)
(88% documented)
</p>
<p class="header-col--secondary">
@ -255,6 +255,21 @@ as expected regardless of the selected <code>TimerHandler</code> implementation.
<p>This type is an implementation detail and should not be used directly, unless implementing your own metrics backend.
To use the SwiftMetrics API, please refer to the documentation of <code><a href="Enums/MetricsSystem.html">MetricsSystem</a></code>.</p>
<h1 id='destroying-metrics' class='heading'>Destroying metrics</h1>
<p>Since <em>some</em> metrics implementations may need to allocate (potentially <q>heavy</q>) resources for metrics, destroying
metrics offers a signal to libraries when a metric is <q>known to never be updated again.</q></p>
<p>While many metrics are bound to the entire lifetime of an application and thus never need to be destroyed eagerly,
some metrics have well defined unique life-cycles, and it may be beneficial to release any resources held by them
more eagerly than awaiting the applications termination. In such cases, a library or application should invoke
a metric&rsquo;s appropriate <code>destroy()</code> method, which in turn results in the corresponding handler that it is backed by
to be passed to <code>destroyCounter(handler:)</code>, <code>destroyRecorder(handler:)</code> or <code>destroyTimer(handler:)</code> where the factory
can decide to free any corresponding resources.</p>
<p>While some libraries may not need to implement this destroying as they may be stateless or similar,
libraries using the metrics API should always assume a library WILL make use of this signal, and shall not
neglect calling these methods when appropriate.</p>
<a href="Protocols/MetricsFactory.html" class="slightly-smaller">See more</a>
</div>
@ -277,7 +292,7 @@ To use the SwiftMetrics API, please refer to the documentation of <code><a href=
</article>
</div>
<section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-10)</p>
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>

4
docs/current/CoreMetrics/Protocols/CounterHandler.html
View File

@ -23,7 +23,7 @@
<a class="header-link" href="../index.html">
CoreMetrics Docs
</a>
(85% documented)
(88% documented)
</p>
<p class="header-col--secondary">
@ -212,7 +212,7 @@ as expected regardless of the selected <code>CounterHandler</code> implementatio
</article>
</div>
<section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-10)</p>
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>

160
docs/current/CoreMetrics/Protocols/MetricsFactory.html
View File

@ -23,7 +23,7 @@
<a class="header-link" href="../index.html">
CoreMetrics Docs
</a>
(85% documented)
(88% documented)
</p>
<p class="header-col--secondary">
@ -122,6 +122,21 @@
<p>This type is an implementation detail and should not be used directly, unless implementing your own metrics backend.
To use the SwiftMetrics API, please refer to the documentation of <code><a href="../Enums/MetricsSystem.html">MetricsSystem</a></code>.</p>
<h1 id='destroying-metrics' class='heading'>Destroying metrics</h1>
<p>Since <em>some</em> metrics implementations may need to allocate (potentially <q>heavy</q>) resources for metrics, destroying
metrics offers a signal to libraries when a metric is <q>known to never be updated again.</q></p>
<p>While many metrics are bound to the entire lifetime of an application and thus never need to be destroyed eagerly,
some metrics have well defined unique life-cycles, and it may be beneficial to release any resources held by them
more eagerly than awaiting the applications termination. In such cases, a library or application should invoke
a metric&rsquo;s appropriate <code>destroy()</code> method, which in turn results in the corresponding handler that it is backed by
to be passed to <code>destroyCounter(handler:)</code>, <code>destroyRecorder(handler:)</code> or <code>destroyTimer(handler:)</code> where the factory
can decide to free any corresponding resources.</p>
<p>While some libraries may not need to implement this destroying as they may be stateless or similar,
libraries using the metrics API should always assume a library WILL make use of this signal, and shall not
neglect calling these methods when appropriate.</p>
</div>
</section>
@ -316,6 +331,147 @@ To use the SwiftMetrics API, please refer to the documentation of <code><a href=
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11CoreMetrics0B7FactoryP14destroyCounteryyAA0E7Handler_pF"></a>
<a name="//apple_ref/swift/Method/destroyCounter(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:11CoreMetrics0B7FactoryP14destroyCounteryyAA0E7Handler_pF">destroyCounter(_:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Invoked when the corresponding <code><a href="../Classes/Counter.html">Counter</a></code>&lsquo;s <code>destroy()</code> function is invoked.
Upon receiving this signal the factory may eagerly release any resources related to this counter.</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">func</span> <span class="nf">destroyCounter</span><span class="p">(</span><span class="n">_</span> <span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Protocols/CounterHandler.html">CounterHandler</a></span><span class="p">)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>handler</em>
</code>
</td>
<td>
<div>
<p>The handler to be destroyed.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11CoreMetrics0B7FactoryP15destroyRecorderyyAA0E7Handler_pF"></a>
<a name="//apple_ref/swift/Method/destroyRecorder(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:11CoreMetrics0B7FactoryP15destroyRecorderyyAA0E7Handler_pF">destroyRecorder(_:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Invoked when the corresponding <code><a href="../Classes/Recorder.html">Recorder</a></code>&lsquo;s <code>destroy()</code> function is invoked.
Upon receiving this signal the factory may eagerly release any resources related to this recorder.</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">func</span> <span class="nf">destroyRecorder</span><span class="p">(</span><span class="n">_</span> <span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Protocols/RecorderHandler.html">RecorderHandler</a></span><span class="p">)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>handler</em>
</code>
</td>
<td>
<div>
<p>The handler to be destroyed.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11CoreMetrics0B7FactoryP12destroyTimeryyAA0E7Handler_pF"></a>
<a name="//apple_ref/swift/Method/destroyTimer(_:)" class="dashAnchor"></a>
<a class="token" href="#/s:11CoreMetrics0B7FactoryP12destroyTimeryyAA0E7Handler_pF">destroyTimer(_:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Invoked when the corresponding <code><a href="../Classes/Timer.html">Timer</a></code>&lsquo;s <code>destroy()</code> function is invoked.
Upon receiving this signal the factory may eagerly release any resources related to this timer.</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">func</span> <span class="nf">destroyTimer</span><span class="p">(</span><span class="n">_</span> <span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Protocols/TimerHandler.html">TimerHandler</a></span><span class="p">)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>handler</em>
</code>
</td>
<td>
<div>
<p>The handler to be destroyed.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
@ -324,7 +480,7 @@ To use the SwiftMetrics API, please refer to the documentation of <code><a href=
</article>
</div>
<section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-10)</p>
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>

4
docs/current/CoreMetrics/Protocols/RecorderHandler.html
View File

@ -23,7 +23,7 @@
<a class="header-link" href="../index.html">
CoreMetrics Docs
</a>
(85% documented)
(88% documented)
</p>
<p class="header-col--secondary">
@ -231,7 +231,7 @@ as expected regardless of the selected <code>RecorderHandler</code> implementati
</article>
</div>
<section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-10)</p>
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>

4
docs/current/CoreMetrics/Protocols/TimerHandler.html
View File

@ -23,7 +23,7 @@
<a class="header-link" href="../index.html">
CoreMetrics Docs
</a>
(85% documented)
(88% documented)
</p>
<p class="header-col--secondary">
@ -185,7 +185,7 @@ as expected regardless of the selected <code>TimerHandler</code> implementation.
</article>
</div>
<section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-10)</p>
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>

4
docs/current/CoreMetrics/badge.svg
View File

@ -19,10 +19,10 @@
documentation
</text>
<text x="1095" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="250">
85%
88%
</text>
<text x="1095" y="140" transform="scale(.1)" textLength="250">
85%
88%
</text>
</g>
</svg>

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 1.1 KiB

After

Width:  |  Height:  |  Size: 1.1 KiB

4
docs/current/CoreMetrics/index.html
View File

@ -22,7 +22,7 @@
<a class="header-link" href="index.html">
CoreMetrics Docs
</a>
(85% documented)
(88% documented)
</p>
<p class="header-col--secondary">
@ -131,7 +131,7 @@
</article>
</div>
<section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-10)</p>
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>

2
docs/current/CoreMetrics/search.json
View File

File diff suppressed because one or more lines are too long

18
docs/current/CoreMetrics/undocumented.json
View File

@ -2,63 +2,63 @@
"warnings": [
{
"file": "/code/Sources/CoreMetrics/Metrics.swift",
"line": 42,
"line": 43,
"symbol": "Counter.label",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
"file": "/code/Sources/CoreMetrics/Metrics.swift",
"line": 43,
"line": 44,
"symbol": "Counter.dimensions",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
"file": "/code/Sources/CoreMetrics/Metrics.swift",
"line": 123,
"line": 132,
"symbol": "Recorder.label",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
"file": "/code/Sources/CoreMetrics/Metrics.swift",
"line": 124,
"line": 133,
"symbol": "Recorder.dimensions",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
"file": "/code/Sources/CoreMetrics/Metrics.swift",
"line": 125,
"line": 134,
"symbol": "Recorder.aggregate",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
"file": "/code/Sources/CoreMetrics/Metrics.swift",
"line": 213,
"line": 229,
"symbol": "Timer.label",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
"file": "/code/Sources/CoreMetrics/Metrics.swift",
"line": 214,
"line": 230,
"symbol": "Timer.dimensions",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
"file": "/code/Sources/CoreMetrics/Metrics.swift",
"line": 375,
"line": 452,
"symbol": "MultiplexMetricsHandler.init(factories:)",
"symbol_kind": "source.lang.swift.decl.function.method.instance",
"warning": "undocumented"
},
{
"file": "/code/Sources/CoreMetrics/Metrics.swift",
"line": 435,
"line": 532,
"symbol": "NOOPMetricsHandler.instance",
"symbol_kind": "source.lang.swift.decl.var.static",
"warning": "undocumented"

2
docs/current/Metrics/Extensions.html
View File

@ -109,7 +109,7 @@
</article>
</div>
<section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-10)</p>
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>

2
docs/current/Metrics/Extensions/Timer.html
View File

@ -256,7 +256,7 @@
</article>
</div>
<section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-10)</p>
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>

2
docs/current/Metrics/index.html
View File

@ -91,7 +91,7 @@
</article>
</div>
<section class="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-10)</p>
<p>&copy; 2019 <a class="link" href="https://github.com/apple/swift-metrics" target="_blank" rel="external">SwiftMetrics team</a>. All rights reserved. (Last updated: 2019-04-22)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>