deploy: 0bc52ef

ksletmoe · Mar 9, 2024 · 3faec70 · 3faec70
1 parent ea68921
commit 3faec70
Show file tree

Hide file tree

Showing 20 changed files with 40 additions and 40 deletions.
diff --git a/...m.sletmoe.bucket4k/-suspending-bucket-configuration/-suspending-bucket-configuration.html b/...m.sletmoe.bucket4k/-suspending-bucket-configuration/-suspending-bucket-configuration.html
@@ -40,7 +40,7 @@
             </a>
     </div>
     <div>
-1.0.0.40-SNAPSHOT    </div>
+1.0.0.41-SNAPSHOT    </div>
     <div class="pull-right d-flex">
         <div class="filter-section" id="filter-section">
                 <button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
@@ -62,7 +62,7 @@ <h1 class="cover"><span>Suspending</span><wbr></wbr><span>Bucket</span><wbr></wb
   <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">timeMeter<span class="token operator">: </span><span data-unresolved-link="io.github.bucket4j/TimeMeter///PointingToDeclaration/">TimeMeter</span><span class="token operator"> = </span>TimeMeter.SYSTEM_MILLISECONDS<span class="token punctuation">, </span></span><span class="parameter ">mutableLimits<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html">MutableList</a><span class="token operator">&lt;</span><span class="token keyword"></span><span data-unresolved-link="io.github.bucket4j/Bandwidth///PointingToDeclaration/">Bandwidth</span><span class="token operator">&gt;</span><span class="token operator"> = </span>mutableListOf()</span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ksletmoe/Bucket4k/tree/mainline/src/main/kotlin/com/sletmoe/bucket4k/SuspendingBucketConfiguration.kt#L9">source</a>)</span></span></div></div></div>
 </div>
       <div class="footer">
-        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
+        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
                 class="pull-right"><span>Generated by </span><a
                 href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
       </div>

diff --git a/bucket4k/com.sletmoe.bucket4k/-suspending-bucket-configuration/add-limit.html b/bucket4k/com.sletmoe.bucket4k/-suspending-bucket-configuration/add-limit.html
@@ -40,7 +40,7 @@
             </a>
     </div>
     <div>
-1.0.0.40-SNAPSHOT    </div>
+1.0.0.41-SNAPSHOT    </div>
     <div class="pull-right d-flex">
         <div class="filter-section" id="filter-section">
                 <button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
@@ -62,7 +62,7 @@ <h1 class="cover"><span>add</span><wbr></wbr><span><span>Limit</span></span></h1
   <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="add-limit.html"><span class="token function">addLimit</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">bandwidth<span class="token operator">: </span><span data-unresolved-link="io.github.bucket4j/Bandwidth///PointingToDeclaration/">Bandwidth</span></span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ksletmoe/Bucket4k/tree/mainline/src/main/kotlin/com/sletmoe/bucket4k/SuspendingBucketConfiguration.kt#L26">source</a>)</span></span></div><p class="paragraph">Adds a <a href="add-limit.html">bandwidth</a> limit to the bucket. See the Bucket4j documentation on <a href="https://bucket4j.com/8.2.0/toc.html#bandwidth">Bandwidths</a> for more information.</p></div></div>
 </div>
       <div class="footer">
-        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
+        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
                 class="pull-right"><span>Generated by </span><a
                 href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
       </div>

diff --git a/bucket4k/com.sletmoe.bucket4k/-suspending-bucket-configuration/index.html b/bucket4k/com.sletmoe.bucket4k/-suspending-bucket-configuration/index.html
@@ -40,7 +40,7 @@
             </a>
     </div>
     <div>
-1.0.0.40-SNAPSHOT    </div>
+1.0.0.41-SNAPSHOT    </div>
     <div class="pull-right d-flex">
         <div class="filter-section" id="filter-section">
                 <button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
@@ -124,7 +124,7 @@ <h2 class="">Properties</h2>
   </div>
 </div>
       <div class="footer">
-        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
+        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
                 class="pull-right"><span>Generated by </span><a
                 href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
       </div>

diff --git a/bucket4k/com.sletmoe.bucket4k/-suspending-bucket-configuration/time-meter.html b/bucket4k/com.sletmoe.bucket4k/-suspending-bucket-configuration/time-meter.html
@@ -40,7 +40,7 @@
             </a>
     </div>
     <div>
-1.0.0.40-SNAPSHOT    </div>
+1.0.0.41-SNAPSHOT    </div>
     <div class="pull-right d-flex">
         <div class="filter-section" id="filter-section">
                 <button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
@@ -62,7 +62,7 @@ <h1 class="cover"><span>time</span><wbr></wbr><span><span>Meter</span></span></h
   <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="time-meter.html">timeMeter</a><span class="token operator">: </span><span data-unresolved-link="io.github.bucket4j/TimeMeter///PointingToDeclaration/">TimeMeter</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ksletmoe/Bucket4k/tree/mainline/src/main/kotlin/com/sletmoe/bucket4k/SuspendingBucketConfiguration.kt#L16">source</a>)</span></span></div><p class="paragraph">Set's the TimeMeter to be used by the underlying Bucket4j objects. By default, you may choose either TimeMeter.SYSTEM_MILLISECONDS or TimeMeter.SYSTEM_NANOSECONDS. Caution: see Bucket4j's <a href="https://bucket4j.com/8.2.0/toc.html#customizing-time-measurement-choosing-nanotime-time-resolution">documentation about using nanoseconds</a> before choosing that option.</p></div></div>
 </div>
       <div class="footer">
-        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
+        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
                 class="pull-right"><span>Generated by </span><a
                 href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
       </div>

diff --git a/bucket4k/com.sletmoe.bucket4k/-suspending-bucket-test/-suspending-bucket-test.html b/bucket4k/com.sletmoe.bucket4k/-suspending-bucket-test/-suspending-bucket-test.html
@@ -40,7 +40,7 @@
             </a>
     </div>
     <div>
-1.0.0.40-SNAPSHOT    </div>
+1.0.0.41-SNAPSHOT    </div>
     <div class="pull-right d-flex">
         <div class="filter-section" id="filter-section">
                 <button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
@@ -62,7 +62,7 @@ <h1 class="cover"><span>Suspending</span><wbr></wbr><span>Bucket</span><wbr></wb
   <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ksletmoe/Bucket4k/tree/mainline/src/test/kotlin/com/sletmoe/bucket4k/SuspendingBucketTest.kt#L19">source</a>)</span></span></div></div></div>
 </div>
       <div class="footer">
-        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
+        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
                 class="pull-right"><span>Generated by </span><a
                 href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
       </div>

diff --git a/bucket4k/com.sletmoe.bucket4k/-suspending-bucket-test/index.html b/bucket4k/com.sletmoe.bucket4k/-suspending-bucket-test/index.html
@@ -40,7 +40,7 @@
             </a>
     </div>
     <div>
-1.0.0.40-SNAPSHOT    </div>
+1.0.0.41-SNAPSHOT    </div>
     <div class="pull-right d-flex">
         <div class="filter-section" id="filter-section">
                 <button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
@@ -86,7 +86,7 @@ <h2 class="">Constructors</h2>
   </div>
 </div>
       <div class="footer">
-        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
+        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
                 class="pull-right"><span>Generated by </span><a
                 href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
       </div>

diff --git a/bucket4k/com.sletmoe.bucket4k/-suspending-bucket/-companion/build.html b/bucket4k/com.sletmoe.bucket4k/-suspending-bucket/-companion/build.html
@@ -40,7 +40,7 @@
             </a>
     </div>
     <div>
-1.0.0.40-SNAPSHOT    </div>
+1.0.0.41-SNAPSHOT    </div>
     <div class="pull-right d-flex">
         <div class="filter-section" id="filter-section">
                 <button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
@@ -62,7 +62,7 @@ <h1 class="cover"><span><span>build</span></span></h1>
   <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="build.html"><span class="token function">build</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">configure<span class="token operator">: </span><span class="token keyword"></span><a href="../../-suspending-bucket-configuration/index.html">SuspendingBucketConfiguration</a><span class="token punctuation">.</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a><span class="token operator"> = </span>{}</span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../index.html">SuspendingBucket</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ksletmoe/Bucket4k/tree/mainline/src/main/kotlin/com/sletmoe/bucket4k/SuspendingBucket.kt#L134">source</a>)</span></span></div><p class="paragraph">A <a href="https://kotlinlang.org/docs/type-safe-builders.html">type-safe builder</a> for constructing SuspendingBucket objects.</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">A SuspendingBucket, constructed with the specified configuration.</p></span><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>configure</span></span></u></div></span></div><div><div class="title"><p class="paragraph">A <a href="https://kotlinlang.org/docs/lambdas.html#function-literals-with-receiver">function literal with receiver</a>, used for specifying SuspendingBucket configuration.</p></div></div></div></div></div></div></div>
 </div>
       <div class="footer">
-        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
+        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
                 class="pull-right"><span>Generated by </span><a
                 href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
       </div>

diff --git a/bucket4k/com.sletmoe.bucket4k/-suspending-bucket/-companion/index.html b/bucket4k/com.sletmoe.bucket4k/-suspending-bucket/-companion/index.html
@@ -40,7 +40,7 @@
             </a>
     </div>
     <div>
-1.0.0.40-SNAPSHOT    </div>
+1.0.0.41-SNAPSHOT    </div>
     <div class="pull-right d-flex">
         <div class="filter-section" id="filter-section">
                 <button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
@@ -86,7 +86,7 @@ <h2 class="">Functions</h2>
   </div>
 </div>
       <div class="footer">
-        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
+        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
                 class="pull-right"><span>Generated by </span><a
                 href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
       </div>

diff --git a/bucket4k/com.sletmoe.bucket4k/-suspending-bucket/add-tokens.html b/bucket4k/com.sletmoe.bucket4k/-suspending-bucket/add-tokens.html
@@ -40,7 +40,7 @@
             </a>
     </div>
     <div>
-1.0.0.40-SNAPSHOT    </div>
+1.0.0.41-SNAPSHOT    </div>
     <div class="pull-right d-flex">
         <div class="filter-section" id="filter-section">
                 <button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
@@ -62,7 +62,7 @@ <h1 class="cover"><span>add</span><wbr></wbr><span><span>Tokens</span></span></h
   <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="add-tokens.html"><span class="token function">addTokens</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">tokensToAdd<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a></span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ksletmoe/Bucket4k/tree/mainline/src/main/kotlin/com/sletmoe/bucket4k/SuspendingBucket.kt#L95">source</a>)</span></span></div><p class="paragraph">Adds the specified number of <a href="add-tokens.html">tokensToAdd</a> to the bucket, not exceeding the capacity of the bucket. Delegates directly to the underlying LockFreeBucket's <a href="https://bucket4j.com/8.2.0/toc.html#addtokens">addTokens</a> implementation.</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>tokens</span><wbr></wbr><span>To</span><wbr></wbr><span><span>Add</span></span></u></div></span></div><div><div class="title"><p class="paragraph">The number of tokens to add to the bucket.</p></div></div></div></div></div></div></div>
 </div>
       <div class="footer">
-        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
+        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
                 class="pull-right"><span>Generated by </span><a
                 href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
       </div>

diff --git a/bucket4k/com.sletmoe.bucket4k/-suspending-bucket/available-tokens.html b/bucket4k/com.sletmoe.bucket4k/-suspending-bucket/available-tokens.html
@@ -40,7 +40,7 @@
             </a>
     </div>
     <div>
-1.0.0.40-SNAPSHOT    </div>
+1.0.0.41-SNAPSHOT    </div>
     <div class="pull-right d-flex">
         <div class="filter-section" id="filter-section">
                 <button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
@@ -62,7 +62,7 @@ <h1 class="cover"><span>available</span><wbr></wbr><span><span>Tokens</span></sp
   <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="available-tokens.html">availableTokens</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ksletmoe/Bucket4k/tree/mainline/src/main/kotlin/com/sletmoe/bucket4k/SuspendingBucket.kt#L26">source</a>)</span></span></div><p class="paragraph">Returns the number of currently available tokens. Delegates directly to the underlying LockFreeBucket's <a href="https://bucket4j.com/8.2.0/toc.html#getavailabletokens">getAvailableTokens</a> implementation.</p></div></div>
 </div>
       <div class="footer">
-        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
+        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
                 class="pull-right"><span>Generated by </span><a
                 href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
       </div>

diff --git a/bucket4k/com.sletmoe.bucket4k/-suspending-bucket/configuration.html b/bucket4k/com.sletmoe.bucket4k/-suspending-bucket/configuration.html
@@ -40,7 +40,7 @@
             </a>
     </div>
     <div>
-1.0.0.40-SNAPSHOT    </div>
+1.0.0.41-SNAPSHOT    </div>
     <div class="pull-right d-flex">
         <div class="filter-section" id="filter-section">
                 <button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
@@ -62,7 +62,7 @@ <h1 class="cover"><span><span>configuration</span></span></h1>
   <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="configuration.html">configuration</a><span class="token operator">: </span><span data-unresolved-link="io.github.bucket4j/BucketConfiguration///PointingToDeclaration/">BucketConfiguration</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/ksletmoe/Bucket4k/tree/mainline/src/main/kotlin/com/sletmoe/bucket4k/SuspendingBucket.kt#L32">source</a>)</span></span></div><p class="paragraph">Returns the Bucket4j BucketConfiguration of the underlying LockFreeBucket. Delegates directly to the underlying LockFreeBucket's getConfiguration implementation.</p></div></div>
 </div>
       <div class="footer">
-        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
+        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
                 class="pull-right"><span>Generated by </span><a
                 href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
       </div>