Skip to content

Commit

Permalink
Deploying to gh-pages from @ b6b4d52 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
JakeWharton committed Dec 4, 2024
1 parent 04340f9 commit 3884ef5
Show file tree
Hide file tree
Showing 13 changed files with 25 additions and 25 deletions.
8 changes: 4 additions & 4 deletions 3.x/okio/okio/okio/-byte-string/-companion/index.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ <h1 class="cover"><span>as</span><wbr></wbr><span>Okio</span><wbr></wbr><span>Fi
</div>
<div class="platform-hinted 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=":okio:dokkaHtml/jvmMain" data-filterable-set=":okio:dokkaHtml/jvmMain" data-active="" data-toggle=":okio:dokkaHtml/jvmMain">jvm</button></div>
<div class="content sourceset-dependent-content" data-active="" data-togglable=":okio:dokkaHtml/jvmMain"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-name/index.html"><span class="token annotation builtin">JvmName</span></a><span class="token punctuation">(</span><span>name<span class="token operator"> = </span><span class="breakable-word"><span class="token string">&quot;get&quot;</span></span></span><wbr></wbr><span class="token punctuation">)</span></div><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-static/index.html"><span class="token annotation builtin">JvmStatic</span></a></div></div><span class="token keyword">fun </span><a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/FileSystem.html">FileSystem</a><span class="token punctuation">.</span><a href="as-okio-file-system.html"><span class="token function">asOkioFileSystem</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../index.html">FileSystem</a></div><p class="paragraph">Closing the returned file system will close the underlying <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/FileSystem.html">java.nio.file.FileSystem</a>.</p><p class="paragraph">Note that the <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/FileSystems.html#getDefault--">default file system</a> is not closeable and calling its close function will throw an <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unsupported-operation-exception/index.html">UnsupportedOperationException</a>.</p></div> </div>
<div class="content sourceset-dependent-content" data-active="" data-togglable=":okio:dokkaHtml/jvmMain"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-name/index.html"><span class="token annotation builtin">JvmName</span></a><span class="token punctuation">(</span><span>name<span class="token operator"> = </span><span class="breakable-word"><span class="token string">&quot;get&quot;</span></span></span><wbr></wbr><span class="token punctuation">)</span></div><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-static/index.html"><span class="token annotation builtin">JvmStatic</span></a></div></div><span class="token keyword">fun </span><a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/FileSystem.html">FileSystem</a><span class="token punctuation">.</span><a href="as-okio-file-system.html"><span class="token function">asOkioFileSystem</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../index.html">FileSystem</a></div><p class="paragraph">Closing the returned file system will close the underlying <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/FileSystem.html">java.nio.file.FileSystem</a>.</p><p class="paragraph">Note that the <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/file/FileSystems.html#getDefault--">default file system</a> is not closeable and calling its close function will throw an <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html">UnsupportedOperationException</a>.</p></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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ <h1 class="cover"><span>deadline</span><wbr></wbr><span>Nano</span><wbr></wbr><s
</div>
<div class="platform-hinted 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=":okio:dokkaHtml/jvmMain" data-filterable-set=":okio:dokkaHtml/jvmMain" data-active="" data-toggle=":okio:dokkaHtml/jvmMain">jvm</button></div>
<div class="content sourceset-dependent-content" data-active="" data-togglable=":okio:dokkaHtml/jvmMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="deadline-nano-time.html"><span class="token function">deadlineNanoTime</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a></div><p class="paragraph">Returns the <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/System.html#nanoTime--">nano time</a> when the deadline will be reached.</p><h4 class="">Throws</h4><div class="table"><div class="table-row" data-filterable-current=":okio:dokkaHtml/jvmMain" data-filterable-set=":okio:dokkaHtml/jvmMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html"><span>Illegal</span><wbr></wbr><span>State</span><wbr></wbr><span><span>Exception</span></span></a></div></span></div><div><div class="title"><p class="paragraph">if no deadline is set.</p></div></div></div></div></div><hr><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="deadline-nano-time.html"><span class="token function">deadlineNanoTime</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">deadlineNanoTime<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="token operator">: </span><a href="../-timeout/index.html">Timeout</a></div><p class="paragraph">Sets the <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/System.html#nanoTime--">nano time</a> when the deadline will be reached. All operations must complete before this time. Use a deadline to set a maximum bound on the time spent on a sequence of operations.</p></div> </div>
<div class="content sourceset-dependent-content" data-active="" data-togglable=":okio:dokkaHtml/jvmMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="deadline-nano-time.html"><span class="token function">deadlineNanoTime</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a></div><p class="paragraph">Returns the <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/System.html#nanoTime--">nano time</a> when the deadline will be reached.</p><h4 class="">Throws</h4><div class="table"><div class="table-row" data-filterable-current=":okio:dokkaHtml/jvmMain" data-filterable-set=":okio:dokkaHtml/jvmMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html"><span>Illegal</span><wbr></wbr><span>State</span><wbr></wbr><span><span>Exception</span></span></a></div></span></div><div><div class="title"><p class="paragraph">if no deadline is set.</p></div></div></div></div></div><hr><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="deadline-nano-time.html"><span class="token function">deadlineNanoTime</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">deadlineNanoTime<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="token operator">: </span><a href="../-timeout/index.html">Timeout</a></div><p class="paragraph">Sets the <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/System.html#nanoTime--">nano time</a> when the deadline will be reached. All operations must complete before this time. Use a deadline to set a maximum bound on the time spent on a sequence of operations.</p></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
Expand Down
2 changes: 1 addition & 1 deletion 3.x/okio/okio/okio/-pipe/fold.html
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ <h1 class="cover"><span><span>fold</span></span></h1>
</div>
<div class="platform-hinted 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=":okio:dokkaHtml/jvmMain" data-filterable-set=":okio:dokkaHtml/jvmMain" data-active="" data-toggle=":okio:dokkaHtml/jvmMain">jvm</button></div>
<div class="content sourceset-dependent-content" data-active="" data-togglable=":okio:dokkaHtml/jvmMain"><div class="symbol monospace"><span class="token keyword">fun </span><a href="fold.html"><span class="token function">fold</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">sink<span class="token operator">: </span><a href="../-sink/index.html">Sink</a></span></span><span class="token punctuation">)</span></div><p class="paragraph">Writes any buffered contents of this pipe to <code class="lang-kotlin">sink</code>, then replace this pipe's source with <code class="lang-kotlin">sink</code>. This pipe's source is closed and attempts to read it will throw an <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html">IllegalStateException</a>.</p><p class="paragraph">This method must not be called while concurrently accessing this pipe's source. It is safe, however, to call this while concurrently writing this pipe's sink.</p></div> </div>
<div class="content sourceset-dependent-content" data-active="" data-togglable=":okio:dokkaHtml/jvmMain"><div class="symbol monospace"><span class="token keyword">fun </span><a href="fold.html"><span class="token function">fold</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">sink<span class="token operator">: </span><a href="../-sink/index.html">Sink</a></span></span><span class="token punctuation">)</span></div><p class="paragraph">Writes any buffered contents of this pipe to <code class="lang-kotlin">sink</code>, then replace this pipe's source with <code class="lang-kotlin">sink</code>. This pipe's source is closed and attempts to read it will throw an <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html">IllegalStateException</a>.</p><p class="paragraph">This method must not be called while concurrently accessing this pipe's source. It is safe, however, to call this while concurrently writing this pipe's sink.</p></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
Expand Down
2 changes: 1 addition & 1 deletion 3.x/okio/okio/okio/-pipe/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ <h2 class="">Functions</h2>
<div class="title">
<div class="platform-hinted 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=":okio:dokkaHtml/jvmMain" data-filterable-set=":okio:dokkaHtml/jvmMain" data-active="" data-toggle=":okio:dokkaHtml/jvmMain">jvm</button></div>
<div class="content sourceset-dependent-content" data-active="" data-togglable=":okio:dokkaHtml/jvmMain"><div class="symbol monospace"><span class="token keyword">fun </span><a href="fold.html"><span class="token function">fold</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">sink<span class="token operator">: </span><a href="../-sink/index.html">Sink</a></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Writes any buffered contents of this pipe to <code class="lang-kotlin">sink</code>, then replace this pipe's source with <code class="lang-kotlin">sink</code>. This pipe's source is closed and attempts to read it will throw an <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html">IllegalStateException</a>.</p></div></div> </div>
<div class="content sourceset-dependent-content" data-active="" data-togglable=":okio:dokkaHtml/jvmMain"><div class="symbol monospace"><span class="token keyword">fun </span><a href="fold.html"><span class="token function">fold</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">sink<span class="token operator">: </span><a href="../-sink/index.html">Sink</a></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Writes any buffered contents of this pipe to <code class="lang-kotlin">sink</code>, then replace this pipe's source with <code class="lang-kotlin">sink</code>. This pipe's source is closed and attempts to read it will throw an <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html">IllegalStateException</a>.</p></div></div> </div>
</div>
</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion 3.x/okio/okio/okio/-timeout/deadline-nano-time.html
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ <h1 class="cover"><span>deadline</span><wbr></wbr><span>Nano</span><wbr></wbr><s
</div>
<div class="platform-hinted 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=":okio:dokkaHtml/jvmMain" data-filterable-set=":okio:dokkaHtml/jvmMain" data-active="" data-toggle=":okio:dokkaHtml/jvmMain">jvm</button></div>
<div class="content sourceset-dependent-content" data-active="" data-togglable=":okio:dokkaHtml/jvmMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">fun </span><a href="deadline-nano-time.html"><span class="token function">deadlineNanoTime</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a></div><p class="paragraph">Returns the <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/System.html#nanoTime--">nano time</a> when the deadline will be reached.</p><h4 class="">Throws</h4><div class="table"><div class="table-row" data-filterable-current=":okio:dokkaHtml/jvmMain" data-filterable-set=":okio:dokkaHtml/jvmMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html"><span>Illegal</span><wbr></wbr><span>State</span><wbr></wbr><span><span>Exception</span></span></a></div></span></div><div><div class="title"><p class="paragraph">if no deadline is set.</p></div></div></div></div></div><hr><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">fun </span><a href="deadline-nano-time.html"><span class="token function">deadlineNanoTime</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">deadlineNanoTime<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="token operator">: </span><a href="index.html">Timeout</a></div><p class="paragraph">Sets the <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/System.html#nanoTime--">nano time</a> when the deadline will be reached. All operations must complete before this time. Use a deadline to set a maximum bound on the time spent on a sequence of operations.</p></div> </div>
<div class="content sourceset-dependent-content" data-active="" data-togglable=":okio:dokkaHtml/jvmMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">fun </span><a href="deadline-nano-time.html"><span class="token function">deadlineNanoTime</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a></div><p class="paragraph">Returns the <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/System.html#nanoTime--">nano time</a> when the deadline will be reached.</p><h4 class="">Throws</h4><div class="table"><div class="table-row" data-filterable-current=":okio:dokkaHtml/jvmMain" data-filterable-set=":okio:dokkaHtml/jvmMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html"><span>Illegal</span><wbr></wbr><span>State</span><wbr></wbr><span><span>Exception</span></span></a></div></span></div><div><div class="title"><p class="paragraph">if no deadline is set.</p></div></div></div></div></div><hr><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">fun </span><a href="deadline-nano-time.html"><span class="token function">deadlineNanoTime</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">deadlineNanoTime<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="token operator">: </span><a href="index.html">Timeout</a></div><p class="paragraph">Sets the <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/System.html#nanoTime--">nano time</a> when the deadline will be reached. All operations must complete before this time. Use a deadline to set a maximum bound on the time spent on a sequence of operations.</p></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
Expand Down
Loading

0 comments on commit 3884ef5

Please sign in to comment.