Skip to content

Commit

Permalink
Docs for release 0.5.4
Browse files Browse the repository at this point in the history
  • Loading branch information
@fzhinkin
fzhinkin committed Sep 17, 2024
1 parent c9f9a7f commit 9a1ad94
Show file tree
Hide file tree
Showing 215 changed files with 1,222 additions and 555 deletions.
2 changes: 1 addition & 1 deletion docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
</a>
</div>
<div class="library-version">
0.5.3 </div>
0.5.4 </div>
</div>
</div>
<div class="navigation-controls">
Expand Down
16 changes: 9 additions & 7 deletions docs/kotlinx-io-bytestring/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,11 @@
<a class="library-name--link" href="../index.html">
kotlinx-io
</a> </div>
<div class="library-version">0.5.3
<div class="library-version">0.5.4
</div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector common-like" data-active="" data-filter=":kotlinx-io-bytestring:dokkaHtmlPartial/appleMain">apple</button>
<button class="platform-tag platform-selector common-like" data-active="" data-filter=":kotlinx-io-bytestring:dokkaHtmlPartial/commonMain">common</button>
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":kotlinx-io-bytestring:dokkaHtmlPartial/jvmMain">jvm</button>
</div>
Expand All @@ -59,26 +60,27 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageids="kotlinx-io-bytestring::////PointingToDeclaration//-312603124">
<div class="main-content" id="content" pageids="kotlinx-io-bytestring::////PointingToDeclaration//20030715">
<div class="breadcrumbs"></div>
<div class="cover ">
<h1 class="cover"><span><span>kotlinx-io-bytestring</span></span></h1>
<div class="platform-hinted UnderCoverText with-platform-tabs" data-platform-hinted="data-platform-hinted">
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark" data-filterable-current=":kotlinx-io-bytestring:dokkaHtmlPartial/commonMain" data-filterable-set=":kotlinx-io-bytestring:dokkaHtmlPartial/commonMain" data-active="" data-toggle=":kotlinx-io-bytestring:dokkaHtmlPartial/commonMain">common</button><button class="platform-bookmark" data-filterable-current=":kotlinx-io-bytestring:dokkaHtmlPartial/jvmMain" data-filterable-set=":kotlinx-io-bytestring:dokkaHtmlPartial/jvmMain" data-toggle=":kotlinx-io-bytestring:dokkaHtmlPartial/jvmMain">jvm</button></div>
<div class="content sourceset-dependent-content" data-active="" data-togglable=":kotlinx-io-bytestring:dokkaHtmlPartial/commonMain"><p class="paragraph">The module provides the ByteString - an immutable sequence of bytes, and extensions facilitating work with it.</p></div><div class="content sourceset-dependent-content" data-togglable=":kotlinx-io-bytestring:dokkaHtmlPartial/jvmMain"><p class="paragraph">The module provides the ByteString - an immutable sequence of bytes, and extensions facilitating work with it.</p></div> </div>
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark" data-filterable-current=":kotlinx-io-bytestring:dokkaHtmlPartial/appleMain" data-filterable-set=":kotlinx-io-bytestring:dokkaHtmlPartial/appleMain" data-active="" data-toggle=":kotlinx-io-bytestring:dokkaHtmlPartial/appleMain">apple</button><button class="platform-bookmark" data-filterable-current=":kotlinx-io-bytestring:dokkaHtmlPartial/commonMain" data-filterable-set=":kotlinx-io-bytestring:dokkaHtmlPartial/commonMain" data-toggle=":kotlinx-io-bytestring:dokkaHtmlPartial/commonMain">common</button><button class="platform-bookmark" data-filterable-current=":kotlinx-io-bytestring:dokkaHtmlPartial/jvmMain" data-filterable-set=":kotlinx-io-bytestring:dokkaHtmlPartial/jvmMain" data-toggle=":kotlinx-io-bytestring:dokkaHtmlPartial/jvmMain">jvm</button></div>
<div class="content sourceset-dependent-content" data-active="" data-togglable=":kotlinx-io-bytestring:dokkaHtmlPartial/appleMain"><p class="paragraph">The module provides the ByteString - an immutable sequence of bytes, and extensions facilitating work with it.</p></div><div class="content sourceset-dependent-content" data-togglable=":kotlinx-io-bytestring:dokkaHtmlPartial/commonMain"><p class="paragraph">The module provides the ByteString - an immutable sequence of bytes, and extensions facilitating work with it.</p></div><div class="content sourceset-dependent-content" data-togglable=":kotlinx-io-bytestring:dokkaHtmlPartial/jvmMain"><p class="paragraph">The module provides the ByteString - an immutable sequence of bytes, and extensions facilitating work with it.</p></div> </div>
</div>
<h2 class="">Packages</h2>
<div class="table"><a data-name="853104428%2FPackages%2F-312603124" anchor-label="kotlinx.io.bytestring" id="853104428%2FPackages%2F-312603124" data-filterable-set=":kotlinx-io-bytestring:dokkaHtmlPartial/commonMain,:kotlinx-io-bytestring:dokkaHtmlPartial/jvmMain"></a>
<div class="table-row" data-filterable-current=":kotlinx-io-bytestring:dokkaHtmlPartial/commonMain,:kotlinx-io-bytestring:dokkaHtmlPartial/jvmMain" data-filterable-set=":kotlinx-io-bytestring:dokkaHtmlPartial/commonMain,:kotlinx-io-bytestring:dokkaHtmlPartial/jvmMain">
<div class="table"><a data-name="853104428%2FPackages%2F20030715" anchor-label="kotlinx.io.bytestring" id="853104428%2FPackages%2F20030715" data-filterable-set=":kotlinx-io-bytestring:dokkaHtmlPartial/appleMain,:kotlinx-io-bytestring:dokkaHtmlPartial/commonMain,:kotlinx-io-bytestring:dokkaHtmlPartial/jvmMain"></a>
<div class="table-row" data-filterable-current=":kotlinx-io-bytestring:dokkaHtmlPartial/appleMain,:kotlinx-io-bytestring:dokkaHtmlPartial/commonMain,:kotlinx-io-bytestring:dokkaHtmlPartial/jvmMain" data-filterable-set=":kotlinx-io-bytestring:dokkaHtmlPartial/appleMain,:kotlinx-io-bytestring:dokkaHtmlPartial/commonMain,:kotlinx-io-bytestring:dokkaHtmlPartial/jvmMain">
<div>
<div class="main-subrow ">
<div class=""><span class="inline-flex">
<div><a href="kotlinx.io.bytestring/index.html">kotlinx.io.bytestring</a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="853104428%2FPackages%2F-312603124"></span>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="853104428%2FPackages%2F20030715"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div class="pull-right">
<div class="platform-tags no-gutters">
<div class="platform-tag common-like">apple</div>
<div class="platform-tag common-like">common</div>
<div class="platform-tag jvm-like">jvm</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion ...otlinx-io-bytestring/kotlinx.io.bytestring/-byte-string-builder/-byte-string-builder.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
<a class="library-name--link" href="../../../index.html">
kotlinx-io
</a> </div>
<div class="library-version">0.5.3
<div class="library-version">0.5.4
</div>
</div>
<div class="filter-section" id="filter-section">
Expand Down
2 changes: 1 addition & 1 deletion docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string-builder/append.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
<a class="library-name--link" href="../../../index.html">
kotlinx-io
</a> </div>
<div class="library-version">0.5.3
<div class="library-version">0.5.4
</div>
</div>
<div class="filter-section" id="filter-section">
Expand Down
2 changes: 1 addition & 1 deletion docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string-builder/capacity.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
<a class="library-name--link" href="../../../index.html">
kotlinx-io
</a> </div>
<div class="library-version">0.5.3
<div class="library-version">0.5.4
</div>
</div>
<div class="filter-section" id="filter-section">
Expand Down
2 changes: 1 addition & 1 deletion docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string-builder/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
<a class="library-name--link" href="../../../index.html">
kotlinx-io
</a> </div>
<div class="library-version">0.5.3
<div class="library-version">0.5.4
</div>
</div>
<div class="filter-section" id="filter-section">
Expand Down
2 changes: 1 addition & 1 deletion docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string-builder/size.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
<a class="library-name--link" href="../../../index.html">
kotlinx-io
</a> </div>
<div class="library-version">0.5.3
<div class="library-version">0.5.4
</div>
</div>
<div class="filter-section" id="filter-section">
Expand Down
2 changes: 1 addition & 1 deletion docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string-builder/to-byte-string.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
<a class="library-name--link" href="../../../index.html">
kotlinx-io
</a> </div>
<div class="library-version">0.5.3
<div class="library-version">0.5.4
</div>
</div>
<div class="filter-section" id="filter-section">
Expand Down
15 changes: 12 additions & 3 deletions docs/kotlinx-io-bytestring/kotlinx.io.bytestring/-byte-string.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
<a class="library-name--link" href="../../index.html">
kotlinx-io
</a> </div>
<div class="library-version">0.5.3
<div class="library-version">0.5.4
</div>
</div>
<div class="filter-section" id="filter-section">
Expand All @@ -63,7 +63,7 @@
<div class="cover ">
<h1 class="cover"><span>Byte</span><wbr><span><span>String</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kotlinx-io-bytestring:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">fun </span><a href="-byte-string.html"><span class="token function">ByteString</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">vararg </span>bytes<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte/index.html">Byte</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-byte-string/index.html">ByteString</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/kotlin/kotlinx-io/tree/master/bytestring/common/src/ByteString.kt#L34">source</a>)</span></span></div><p class="paragraph">Wraps given <a href="-byte-string.html">bytes</a> into a byte string.</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":kotlinx-io-bytestring:dokkaHtmlPartial/commonMain" data-filterable-set=":kotlinx-io-bytestring:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>bytes</span></span></u></div></span></div><div><div class="title"><p class="paragraph">a sequence of bytes to be wrapped.</p></div></div></div></div></div><h4 class="">Samples</h4><div class="sample-container"><pre><code class="runnablesample monospace block lang-kotlin" theme="idea">import kotlinx.io.bytestring.*
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kotlinx-io-bytestring:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">fun </span><a href="-byte-string.html"><span class="token function">ByteString</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">vararg </span>bytes<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte/index.html">Byte</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-byte-string/index.html">ByteString</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/kotlin/kotlinx-io/tree/master/bytestring/common/src/ByteString.kt#L35">source</a>)</span></span></div><p class="paragraph">Wraps given <a href="-byte-string.html">bytes</a> into a byte string.</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":kotlinx-io-bytestring:dokkaHtmlPartial/commonMain" data-filterable-set=":kotlinx-io-bytestring:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>bytes</span></span></u></div></span></div><div><div class="title"><p class="paragraph">a sequence of bytes to be wrapped.</p></div></div></div></div></div><h4 class="">Samples</h4><div class="sample-container"><pre><code class="runnablesample monospace block lang-kotlin" theme="idea">import kotlinx.io.bytestring.*
import kotlin.test.*

fun main() {
Expand All @@ -76,7 +76,16 @@ <h1 class="cover"><span>Byte</span><wbr><span><span>String</span></span></h1>
assertFalse(byteStringFromBytes.isEmpty())
assertEquals(3, byteStringFromBytes.size)
//sampleEnd
}</code></pre></div></div></div>
}</code></pre></div><hr><div class="symbol monospace"><span class="token keyword">fun </span><a href="-byte-string.html"><span class="token function">ByteString</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">vararg </span>bytes<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html">UByte</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-byte-string/index.html">ByteString</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/kotlin/kotlinx-io/tree/master/bytestring/common/src/ByteString.kt#L52">source</a>)</span></span></div><p class="paragraph">Wraps given <a href="-byte-string.html">bytes</a> into a byte string.</p><p class="paragraph">Internally, <a href="-byte-string.html">bytes</a> will be stored as <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html">ByteArray</a>, and accesses to individual <a href="-byte-string/index.html">ByteString</a>'s bytes will return a signed <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte/index.html">Byte</a> as if someone call <code class="lang-kotlin">bytes[i].toByte()</code>.</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":kotlinx-io-bytestring:dokkaHtmlPartial/commonMain" data-filterable-set=":kotlinx-io-bytestring:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>bytes</span></span></u></div></span></div><div><div class="title"><p class="paragraph">a sequence of bytes to be wrapped.</p></div></div></div></div></div><h4 class="">Samples</h4><div class="sample-container"><pre><code class="runnablesample monospace block lang-kotlin" theme="idea">import kotlinx.io.bytestring.*
import kotlin.test.*

fun main() {
//sampleStart
val byteStringFromBytes = ByteString(0xCAu, 0xFEu)
assertFalse(byteStringFromBytes.isEmpty())
assertEquals(2, byteStringFromBytes.size)
//sampleEnd
}</code></pre></div><hr><div class="symbol monospace"><span class="token keyword">fun </span><a href="-byte-string.html"><span class="token function">ByteString</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-byte-string/index.html">ByteString</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/kotlin/kotlinx-io/tree/master/bytestring/common/src/ByteString.kt#L59">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>© 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>
Expand Down
Loading

0 comments on commit 9a1ad94

Please sign in to comment.