mirror of
https://github.com/InsanusMokrassar/MicroUtils.git
synced 2026-09-29 11:54:53 +00:00
1531 lines
287 KiB
HTML
1531 lines
287 KiB
HTML
<!DOCTYPE html>
|
|
<html class="no-js" lang="en">
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>dev.inmo.micro_utils.coroutines</title>
|
|
<link href="../../images/logo-icon.svg" rel="icon" type="image/svg">
|
|
<script>var pathToRoot = "../../";</script>
|
|
<script>document.documentElement.classList.replace("no-js", "js");</script>
|
|
<script>const storage = localStorage.getItem("dokka-dark-mode")
|
|
if (storage == null) {
|
|
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
|
|
if (osDarkSchemePreferred === true) {
|
|
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
|
}
|
|
} else {
|
|
const savedDarkMode = JSON.parse(storage)
|
|
if (savedDarkMode === true) {
|
|
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
|
}
|
|
}
|
|
</script>
|
|
<script type="text/javascript" src="../../scripts/sourceset_dependencies.js" async="async"></script>
|
|
<link href="../../styles/style.css" rel="Stylesheet">
|
|
<link href="../../styles/main.css" rel="Stylesheet">
|
|
<link href="../../styles/prism.css" rel="Stylesheet">
|
|
<link href="../../styles/logo-styles.css" rel="Stylesheet">
|
|
<link href="../../ui-kit/ui-kit.min.css" rel="Stylesheet">
|
|
<script type="text/javascript" src="../../scripts/safe-local-storage_blocking.js"></script>
|
|
<script type="text/javascript" src="../../scripts/navigation-loader.js" async="async"></script>
|
|
<script type="text/javascript" src="../../scripts/platform-content-handler.js" async="async"></script>
|
|
<script type="text/javascript" src="../../scripts/main.js" defer="defer"></script>
|
|
<script type="text/javascript" src="../../scripts/prism.js" async="async"></script>
|
|
<script type="text/javascript" src="../../ui-kit/ui-kit.min.js" defer="defer"></script>
|
|
</head>
|
|
<body>
|
|
<div class="root">
|
|
<header class="navigation theme-dark" id="navigation-wrapper" role="banner">
|
|
<a class="library-name--link" href="../../index.html" tabindex="1">
|
|
micro_utils.dokka
|
|
</a>
|
|
<button class="navigation-controls--btn navigation-controls--btn_toc ui-kit_mobile-only" id="toc-toggle"
|
|
type="button">Toggle table of contents
|
|
</button>
|
|
<div class="navigation-controls--break ui-kit_mobile-only"></div>
|
|
<div class="library-version" id="library-version">
|
|
0.31.0 </div>
|
|
<div class="navigation-controls">
|
|
<ul class="filter-section filter-section_loading" id="filter-section" aria-label="Target filter">
|
|
<button class="platform-tag platform-selector jvm-like" data-active="" aria-pressed="true"
|
|
data-filter=":micro_utils.dokka/androidMain">android</button>
|
|
<button class="platform-tag platform-selector common-like" data-active="" aria-pressed="true"
|
|
data-filter=":micro_utils.dokka/commonMain">common</button>
|
|
<button class="platform-tag platform-selector js-like" data-active="" aria-pressed="true"
|
|
data-filter=":micro_utils.dokka/jsMain">js</button>
|
|
<div class="dropdown filter-section--dropdown" data-role="dropdown" id="filter-section-dropdown">
|
|
<button class="button button_dropdown filter-section--dropdown-toggle" role="combobox"
|
|
data-role="dropdown-toggle"
|
|
aria-controls="platform-tags-listbox"
|
|
aria-haspopup="listbox"
|
|
aria-expanded="false"
|
|
aria-label="Toggle source sets"
|
|
></button>
|
|
<ul role="listbox" id="platform-tags-listbox" class="dropdown--list" data-role="dropdown-listbox" aria-label="Target filter">
|
|
<div class="dropdown--header"><span>Target filter</span>
|
|
<button class="button" data-role="dropdown-toggle" aria-label="Close target filter">
|
|
<i class="ui-kit-icon ui-kit-icon_cross"></i>
|
|
</button>
|
|
</div>
|
|
<li role="option" class="dropdown--option platform-selector-option jvm-like" tabindex="0">
|
|
<label class="checkbox">
|
|
<input type="checkbox" class="checkbox--input" id=":micro_utils.dokka/androidMain"
|
|
data-filter=":micro_utils.dokka/androidMain"/>
|
|
<span class="checkbox--icon"></span>
|
|
android
|
|
</label>
|
|
</li>
|
|
<li role="option" class="dropdown--option platform-selector-option common-like" tabindex="0">
|
|
<label class="checkbox">
|
|
<input type="checkbox" class="checkbox--input" id=":micro_utils.dokka/commonMain"
|
|
data-filter=":micro_utils.dokka/commonMain"/>
|
|
<span class="checkbox--icon"></span>
|
|
common
|
|
</label>
|
|
</li>
|
|
<li role="option" class="dropdown--option platform-selector-option js-like" tabindex="0">
|
|
<label class="checkbox">
|
|
<input type="checkbox" class="checkbox--input" id=":micro_utils.dokka/jsMain"
|
|
data-filter=":micro_utils.dokka/jsMain"/>
|
|
<span class="checkbox--icon"></span>
|
|
js
|
|
</label>
|
|
</li>
|
|
</ul>
|
|
<div class="dropdown--overlay"></div>
|
|
</div>
|
|
</ul>
|
|
<button class="navigation-controls--btn navigation-controls--btn_theme" id="theme-toggle-button"
|
|
type="button">Switch theme
|
|
</button>
|
|
<div class="navigation-controls--btn navigation-controls--btn_search" id="searchBar" role="button">Search in
|
|
API
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div id="container">
|
|
<nav id="leftColumn" class="sidebar" data-item-type="SECTION" data-item-config='{"defaultSize": 280, "minSize": 200, "maxSize": 400}'>
|
|
<a class="toc--skip-link" href="#main">Skip to content</a>
|
|
<div class="dropdown theme-dark_mobile" data-role="dropdown" id="toc-dropdown">
|
|
<ul role="listbox" id="toc-listbox" class="dropdown--list dropdown--list_toc-list"
|
|
data-role="dropdown-listbox" aria-label="Table of contents">
|
|
<div class="dropdown--header">
|
|
<span>
|
|
micro_utils.dokka
|
|
</span>
|
|
<button class="button" data-role="dropdown-toggle" aria-label="Close table of contents">
|
|
<i class="ui-kit-icon ui-kit-icon_cross"></i>
|
|
</button>
|
|
</div>
|
|
<div class="sidebar--inner" id="sideMenu"></div>
|
|
</ul>
|
|
<div class="dropdown--overlay"></div>
|
|
</div>
|
|
</nav>
|
|
<div id="resizer" class="resizer" data-item-type="BAR"></div>
|
|
<div id="main" data-item-type="SECTION" role="main">
|
|
<div class="main-content" data-page-type="package" id="content" pageIds="micro_utils.dokka::dev.inmo.micro_utils.coroutines////PointingToDeclaration//-1065095707">
|
|
<div class="breadcrumbs"><a href="../../index.html">micro_utils.dokka</a><span class="delimiter">/</span><span class="current">dev.inmo.micro_utils.coroutines</span></div>
|
|
<div class="cover ">
|
|
<h1 class="cover"><span><span>Package-level</span></span> <span><span>declarations</span></span></h1>
|
|
</div>
|
|
<div class="tabbedcontent">
|
|
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="TYPE">Types</button><button class="section-tab" data-togglable="FUNCTION,EXTENSION_FUNCTION">Functions</button><button class="section-tab" data-togglable="PROPERTY,EXTENSION_PROPERTY">Properties</button></div>
|
|
<div class="tabs-section-body">
|
|
<div data-togglable="TYPE">
|
|
<h2 class="tableheader">Types</h2>
|
|
<div class="table"><a data-name="388287563%2FClasslikes%2F-1457309097" anchor-label="AccumulatorFlow" id="388287563%2FClasslikes%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="-accumulator-flow/index.html"><span>Accumulator</span><wbr></wbr><span><span>Flow</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="388287563%2FClasslikes%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">class </span><a href="-accumulator-flow/index.html">AccumulatorFlow</a><span class="token operator"><</span><a href="-accumulator-flow/index.html">T</a><span class="token operator">></span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">sourceDataFlow<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><span class="token operator"><</span><a href="-accumulator-flow/index.html">T</a><span class="token operator">></span><span class="token punctuation">, </span></span><span class="parameter ">scope<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span></span></span><span class="token punctuation">)</span> : <span data-unresolved-link="kotlinx.coroutines.flow/AbstractFlow///PointingToDeclaration/">AbstractFlow</span><span class="token operator"><</span><a href="-accumulator-flow/index.html">T</a><span class="token operator">> </span></div><div class="brief "><p class="paragraph">This <span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span> will have behaviour very similar to <span data-unresolved-link="kotlinx.coroutines.flow/SharedFlow///PointingToDeclaration/">SharedFlow</span>, but there are several differences:</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="861987188%2FClasslikes%2F-1457309097" anchor-label="ActorAction" id="861987188%2FClasslikes%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="-actor-action/index.html"><span>Actor</span><wbr></wbr><span><span>Action</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="861987188%2FClasslikes%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">interface </span><a href="-actor-action/index.html">ActorAction</a><span class="token operator"><</span><a href="-actor-action/index.html">T</a><span class="token operator">></span></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="1934187035%2FClasslikes%2F-1457309097" anchor-label="ContextSafelyExceptionHandler" id="1934187035%2FClasslikes%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="-context-safely-exception-handler/index.html"><span>Context</span><wbr></wbr><span>Safely</span><wbr></wbr><span>Exception</span><wbr></wbr><span><span>Handler</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1934187035%2FClasslikes%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">class </span><a href="-context-safely-exception-handler/index.html">ContextSafelyExceptionHandler</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>handler<span class="token operator">: </span><a href="-exception-handler/index.html">ExceptionHandler</a><span class="token operator"><</span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html">Unit</a><span class="token operator">></span></span></span><span class="token punctuation">)</span> : <a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.coroutines/-coroutine-context/-element/index.html">CoroutineContext.Element</a></div><div class="brief "><p class="paragraph"><a href="-exception-handler/index.html">ExceptionHandler</a> wrapper which was created to make possible to use <span data-unresolved-link="dev.inmo.micro_utils.coroutines/ContextSafelyExceptionHandler//#kotlin.coroutines.SuspendFunction1[kotlin.Throwable,kotlin.Unit]/PointingToCallableParameters(0)/">handler</span> across all coroutines calls</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-1948000088%2FClasslikes%2F-1457309097" anchor-label="ContextSafelyExceptionHandlerKey" id="-1948000088%2FClasslikes%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="-context-safely-exception-handler-key/index.html"><span>Context</span><wbr></wbr><span>Safely</span><wbr></wbr><span>Exception</span><wbr></wbr><span>Handler</span><wbr></wbr><span><span>Key</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1948000088%2FClasslikes%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">object </span><a href="-context-safely-exception-handler-key/index.html">ContextSafelyExceptionHandlerKey</a> : <a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.coroutines/-coroutine-context/-key/index.html">CoroutineContext.Key</a><span class="token operator"><</span><a href="-context-safely-exception-handler/index.html">ContextSafelyExceptionHandler</a><span class="token operator">> </span></div><div class="brief "><p class="paragraph">This key can (and will) be used to get <a href="-context-safely-exception-handler/index.html">ContextSafelyExceptionHandler</a> from <a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.coroutines/index.html">coroutineContext</a> of suspend functions and in <a href="-context-safely-exception-handler/index.html">ContextSafelyExceptionHandler</a> for defining of its <a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.coroutines/-coroutine-context/-element/key.html">CoroutineContext.Element.key</a></p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="913360046%2FClasslikes%2F-1457309097" anchor-label="DeferredAction" id="913360046%2FClasslikes%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="-deferred-action/index.html"><span>Deferred</span><wbr></wbr><span><span>Action</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="913360046%2FClasslikes%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">class </span><a href="-deferred-action/index.html">DeferredAction</a><span class="token operator"><</span><a href="-deferred-action/index.html">T</a><span class="token punctuation">, </span><a href="-deferred-action/index.html">O</a><span class="token operator">></span><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>deferred<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">Deferred</span><span class="token operator"><</span><a href="-deferred-action/index.html">T</a><span class="token operator">></span><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>callback<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><a href="-deferred-action/index.html">T</a><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="-deferred-action/index.html">O</a></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Represents a deferred action that combines a <span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">Deferred</span> value with a callback to be executed on that value.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-713533657%2FClasslikes%2F-1457309097" anchor-label="DoWithFirstBuilder" id="-713533657%2FClasslikes%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="-do-with-first-builder/index.html"><span>Do</span><wbr></wbr><span>With</span><wbr></wbr><span>First</span><wbr></wbr><span><span>Builder</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-713533657%2FClasslikes%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">class </span><a href="-do-with-first-builder/index.html">DoWithFirstBuilder</a><span class="token operator"><</span><a href="-do-with-first-builder/index.html">T</a><span class="token operator">></span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">scope<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">A builder for creating multiple deferred computations that can be executed, with only the first completing one being used. This is useful for race conditions where you want the result of whichever computation finishes first.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-738983448%2FClasslikes%2F-1457309097" anchor-label="ExceptionHandler" id="-738983448%2FClasslikes%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="-exception-handler/index.html"><span>Exception</span><wbr></wbr><span><span>Handler</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-738983448%2FClasslikes%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">typealias </span><a href="-exception-handler/index.html">ExceptionHandler</a><span class="token operator"><</span><a href="-exception-handler/index.html">T</a><span class="token operator">></span><span class="token operator"> = </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-throwable/index.html">Throwable</a><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="-exception-handler/index.html">T</a></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="892520947%2FClasslikes%2F102564003" anchor-label="FlowOnHierarchyChangeListener" id="892520947%2FClasslikes%2F102564003" data-filterable-set=":micro_utils.dokka/androidMain"></a>
|
|
<div class="table-row table-row_content" data-filterable-current=":micro_utils.dokka/androidMain" data-filterable-set=":micro_utils.dokka/androidMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="-flow-on-hierarchy-change-listener/index.html"><span>Flow</span><wbr></wbr><span>On</span><wbr></wbr><span>Hierarchy</span><wbr></wbr><span>Change</span><wbr></wbr><span><span>Listener</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="892520947%2FClasslikes%2F102564003"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<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=":micro_utils.dokka/androidMain" data-filterable-set=":micro_utils.dokka/androidMain" data-active="" data-toggle=":micro_utils.dokka/androidMain">android</button></div>
|
|
<div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/androidMain"><div class="symbol monospace"><span class="token keyword">class </span><a href="-flow-on-hierarchy-change-listener/index.html">FlowOnHierarchyChangeListener</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">recursive<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">false</span><span class="token punctuation">, </span></span><span class="parameter ">_onChildViewAdded<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines.flow/MutableSharedFlow///PointingToDeclaration/">MutableSharedFlow</span><span class="token operator"><</span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-pair/index.html">Pair</a><span class="token operator"><</span><a href="https://developer.android.com/reference/kotlin/android/view/View.html">View</a><span class="token punctuation">, </span><a href="https://developer.android.com/reference/kotlin/android/view/View.html">View</a><span class="token operator">></span><span class="token operator">></span><span class="token operator"> = </span>MutableSharedFlow(extraBufferCapacity = Int.MAX_VALUE)<span class="token punctuation">, </span></span><span class="parameter ">_onChildViewRemoved<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines.flow/MutableSharedFlow///PointingToDeclaration/">MutableSharedFlow</span><span class="token operator"><</span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-pair/index.html">Pair</a><span class="token operator"><</span><a href="https://developer.android.com/reference/kotlin/android/view/View.html">View</a><span class="token punctuation">, </span><a href="https://developer.android.com/reference/kotlin/android/view/View.html">View</a><span class="token operator">></span><span class="token operator">></span><span class="token operator"> = </span>MutableSharedFlow(extraBufferCapacity = Int.MAX_VALUE)</span></span><span class="token punctuation">)</span> : <a href="https://developer.android.com/reference/kotlin/android/view/ViewGroup.OnHierarchyChangeListener.html">ViewGroup.OnHierarchyChangeListener</a></div><div class="brief "><p class="paragraph"><span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">kotlinx.coroutines.flow.Flow</span>-based <a href="https://developer.android.com/reference/kotlin/android/view/ViewGroup.OnHierarchyChangeListener.html">android.view.ViewGroup.OnHierarchyChangeListener</a></p></div></div> </div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="1750947532%2FClasslikes%2F-1457309097" anchor-label="MutableRedeliverStateFlow" id="1750947532%2FClasslikes%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="-mutable-redeliver-state-flow/index.html"><span>Mutable</span><wbr></wbr><span>Redeliver</span><wbr></wbr><span>State</span><wbr></wbr><span><span>Flow</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1750947532%2FClasslikes%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">class </span><a href="-mutable-redeliver-state-flow/index.html">MutableRedeliverStateFlow</a><span class="token operator"><</span><a href="-mutable-redeliver-state-flow/index.html">T</a><span class="token operator">></span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">initialValue<span class="token operator">: </span><a href="-mutable-redeliver-state-flow/index.html">T</a></span></span><span class="token punctuation">)</span> : <span data-unresolved-link="kotlinx.coroutines.flow/MutableStateFlow///PointingToDeclaration/">MutableStateFlow</span><span class="token operator"><</span><a href="-mutable-redeliver-state-flow/index.html">T</a><span class="token operator">> </span>, <span data-unresolved-link="kotlinx.coroutines.flow/FlowCollector///PointingToDeclaration/">FlowCollector</span><span class="token operator"><</span><a href="-mutable-redeliver-state-flow/index.html">T</a><span class="token operator">> </span>, <span data-unresolved-link="kotlinx.coroutines.flow/MutableSharedFlow///PointingToDeclaration/">MutableSharedFlow</span><span class="token operator"><</span><a href="-mutable-redeliver-state-flow/index.html">T</a><span class="token operator">> </span></div><div class="brief "><p class="paragraph">Works like <span data-unresolved-link="kotlinx.coroutines.flow/StateFlow///PointingToDeclaration/">StateFlow</span>, but guarantee that latest value update will always be delivered to each active subscriber</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="77953360%2FClasslikes%2F-1457309097" anchor-label="SmartKeyRWLocker" id="77953360%2FClasslikes%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="-smart-key-r-w-locker/index.html"><span>Smart</span><wbr></wbr><span>Key</span><wbr></wbr><span><span>RWLocker</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="77953360%2FClasslikes%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">class </span><a href="-smart-key-r-w-locker/index.html">SmartKeyRWLocker</a><span class="token operator"><</span><a href="-smart-key-r-w-locker/index.html">T</a><span class="token operator">></span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">globalLockerReadPermits<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html">Int</a><span class="token operator"> = </span>Int.MAX_VALUE<span class="token punctuation">, </span></span><span class="parameter ">globalLockerWriteIsLocked<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">false</span><span class="token punctuation">, </span></span><span class="parameter ">perKeyReadPermits<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html">Int</a><span class="token operator"> = </span>Int.MAX_VALUE</span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Combining <span data-unresolved-link="dev.inmo.micro_utils.coroutines/SmartKeyRWLocker/globalRWLocker/#/PointingToDeclaration/">globalRWLocker</span> and internal map of <a href="-smart-r-w-locker/index.html">SmartRWLocker</a> associated by <a href="-smart-key-r-w-locker/index.html">T</a> to provide next logic:</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="1070794381%2FClasslikes%2F-1457309097" anchor-label="SmartMutex" id="1070794381%2FClasslikes%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="-smart-mutex/index.html"><span>Smart</span><wbr></wbr><span><span>Mutex</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1070794381%2FClasslikes%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">sealed </span><span class="token keyword">interface </span><a href="-smart-mutex/index.html">SmartMutex</a></div><div class="brief "><p class="paragraph">It is interface which will work like classic <span data-unresolved-link="kotlinx.coroutines.sync/Mutex///PointingToDeclaration/">Mutex</span>, but in difference have <a href="-smart-mutex/lock-state-flow.html">lockStateFlow</a> for listening of the <a href="-smart-mutex/index.html">SmartMutex</a> state.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-1062270887%2FClasslikes%2F-1457309097" anchor-label="SmartRWLocker" id="-1062270887%2FClasslikes%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="-smart-r-w-locker/index.html"><span>Smart</span><wbr></wbr><span><span>RWLocker</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1062270887%2FClasslikes%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">class </span><a href="-smart-r-w-locker/index.html">SmartRWLocker</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">readPermits<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html">Int</a><span class="token operator"> = </span>Int.MAX_VALUE<span class="token punctuation">, </span></span><span class="parameter ">writeIsLocked<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">false</span></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Composite mutex which works with next rules:</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-1277010968%2FClasslikes%2F-1457309097" anchor-label="SmartSemaphore" id="-1277010968%2FClasslikes%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="-smart-semaphore/index.html"><span>Smart</span><wbr></wbr><span><span>Semaphore</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1277010968%2FClasslikes%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">sealed </span><span class="token keyword">interface </span><a href="-smart-semaphore/index.html">SmartSemaphore</a></div><div class="brief "><p class="paragraph">It is interface which will work like classic <span data-unresolved-link="kotlinx.coroutines.sync/Semaphore///PointingToDeclaration/">Semaphore</span>, but in difference have <a href="-smart-semaphore/permits-state-flow.html">permitsStateFlow</a> for listening of the <a href="-smart-semaphore/index.html">SmartSemaphore</a> state.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div data-togglable="PROPERTY">
|
|
<h2 class="tableheader">Properties</h2>
|
|
<div class="table"><a data-name="-1221807147%2FProperties%2F-1457309097" anchor-label="asDeferred" id="-1221807147%2FProperties%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_PROPERTY" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="as-deferred.html"><span>as</span><wbr></wbr><span><span>Deferred</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1221807147%2FProperties%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">val </span><span class="token operator"><</span><a href="as-deferred.html">T</a><span class="token operator">> </span><a href="as-deferred.html">T</a><span class="token punctuation">.</span><a href="as-deferred.html">asDeferred</a><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">Deferred</span><span class="token operator"><</span><a href="as-deferred.html">T</a><span class="token operator">></span></div><div class="brief "><p class="paragraph">Wraps this value in a completed <span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">Deferred</span>. The resulting <span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">Deferred</span> is immediately completed with this value. Useful for converting synchronous values to <span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">Deferred</span> in contexts that expect deferred values.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-1388616099%2FProperties%2F-1457309097" anchor-label="Default" id="-1388616099%2FProperties%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="-default.html"><span><span>Default</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1388616099%2FProperties%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">val </span><a href="-default.html">Default</a><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineDispatcher///PointingToDeclaration/">CoroutineDispatcher</span></div><div class="brief "><p class="paragraph">Convenience property to access <span data-unresolved-link="kotlinx.coroutines/Dispatchers/Default/#/PointingToDeclaration/">Dispatchers.Default</span> for CPU-intensive operations.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-1779138104%2FProperties%2F-1457309097" anchor-label="defaultSafelyExceptionHandler" id="-1779138104%2FProperties%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="default-safely-exception-handler.html"><span>default</span><wbr></wbr><span>Safely</span><wbr></wbr><span>Exception</span><wbr></wbr><span><span>Handler</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1779138104%2FProperties%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">var </span><a href="default-safely-exception-handler.html">defaultSafelyExceptionHandler</a><span class="token operator">: </span><a href="-exception-handler/index.html">ExceptionHandler</a><span class="token operator"><</span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-nothing/index.html">Nothing</a><span class="token operator">></span></div><div class="brief "><p class="paragraph">This instance will be used in all calls of <span data-unresolved-link="dev.inmo.micro_utils.coroutines//safely/#kotlin.coroutines.SuspendFunction1[kotlin.Throwable,TypeParam(bounds=[kotlin.Any?])]#kotlin.coroutines.SuspendFunction0[TypeParam(bounds=[kotlin.Any?])]/PointingToDeclaration/">safely</span> where exception handler has not been passed</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="1936273364%2FProperties%2F-1457309097" anchor-label="defaultSafelyWithoutExceptionHandler" id="1936273364%2FProperties%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="default-safely-without-exception-handler.html"><span>default</span><wbr></wbr><span>Safely</span><wbr></wbr><span>Without</span><wbr></wbr><span>Exception</span><wbr></wbr><span><span>Handler</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1936273364%2FProperties%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">var </span><a href="default-safely-without-exception-handler.html">defaultSafelyWithoutExceptionHandler</a><span class="token operator">: </span><a href="-exception-handler/index.html">ExceptionHandler</a><span class="token operator"><</span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html">Unit</a><span class="token operator">></span></div><div class="brief "><p class="paragraph">This instance will be used in all calls of <span data-unresolved-link="dev.inmo.micro_utils.coroutines//safelyWithoutExceptions/#kotlin.coroutines.SuspendFunction1[kotlin.Throwable,TypeParam(bounds=[kotlin.Any?])]#kotlin.coroutines.SuspendFunction0[TypeParam(bounds=[kotlin.Any?])]/PointingToDeclaration/">safelyWithoutExceptions</span> as an exception handler for <span data-unresolved-link="dev.inmo.micro_utils.coroutines//safely/#kotlin.coroutines.SuspendFunction1[kotlin.Throwable,TypeParam(bounds=[kotlin.Any?])]#kotlin.coroutines.SuspendFunction0[TypeParam(bounds=[kotlin.Any?])]/PointingToDeclaration/">safely</span> call</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="213964263%2FProperties%2F-1457309097" anchor-label="defaultSafelyWithoutExceptionHandlerWithNull" id="213964263%2FProperties%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="default-safely-without-exception-handler-with-null.html"><span>default</span><wbr></wbr><span>Safely</span><wbr></wbr><span>Without</span><wbr></wbr><span>Exception</span><wbr></wbr><span>Handler</span><wbr></wbr><span>With</span><wbr></wbr><span><span>Null</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="213964263%2FProperties%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">val </span><a href="default-safely-without-exception-handler-with-null.html">defaultSafelyWithoutExceptionHandlerWithNull</a><span class="token operator">: </span><a href="-exception-handler/index.html">ExceptionHandler</a><span class="token operator"><</span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-nothing/index.html">Nothing</a><span class="token operator">?</span><span class="token operator">></span></div><div class="brief "><p class="paragraph">Use this handler in cases you wish to include handling of exceptions by <a href="default-safely-without-exception-handler.html">defaultSafelyWithoutExceptionHandler</a> and returning null at one time</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-521212568%2FProperties%2F-1457309097" anchor-label="UI" id="-521212568%2FProperties%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="-u-i.html"><span><span>UI</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-521212568%2FProperties%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">val </span><a href="-u-i.html">UI</a><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/MainCoroutineDispatcher///PointingToDeclaration/">MainCoroutineDispatcher</span></div><div class="brief "><p class="paragraph">Convenience property to access <span data-unresolved-link="kotlinx.coroutines/Dispatchers/Main/#/PointingToDeclaration/">Dispatchers.Main</span> for UI operations.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div data-togglable="FUNCTION">
|
|
<h2 class="tableheader">Functions</h2>
|
|
<div class="table"><a data-name="-2014385547%2FFunctions%2F-1457309097" anchor-label="accumulatorFlow" id="-2014385547%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="accumulator-flow.html"><span>accumulator</span><wbr></wbr><span><span>Flow</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-2014385547%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">fun </span><span class="token operator"><</span><a href="accumulator-flow.html">T</a><span class="token operator">> </span><span data-unresolved-link="kotlinx.coroutines.channels/Channel///PointingToDeclaration/">Channel</span><span class="token operator"><</span><a href="accumulator-flow.html">T</a><span class="token operator">></span><span class="token punctuation">.</span><a href="accumulator-flow.html"><span class="token function">accumulatorFlow</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">scope<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><span class="token operator"><</span><a href="accumulator-flow.html">T</a><span class="token operator">></span></div><div class="brief "><p class="paragraph">Creates <a href="-accumulator-flow/index.html">AccumulatorFlow</a> using <span data-unresolved-link="kotlinx.coroutines.channels/Channel///PointingToDeclaration/">this</span> with <span data-unresolved-link="kotlinx.coroutines.flow//receiveAsFlow/kotlinx.coroutines.channels.ReceiveChannel[TypeParam(bounds=[kotlin.Any?])]#/PointingToDeclaration/">receiveAsFlow</span> to get</p></div><div class="symbol monospace"><span class="token keyword">fun </span><span class="token operator"><</span><a href="accumulator-flow.html">T</a><span class="token operator">> </span><span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><span class="token operator"><</span><a href="accumulator-flow.html">T</a><span class="token operator">></span><span class="token punctuation">.</span><a href="accumulator-flow.html"><span class="token function">accumulatorFlow</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">scope<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><span class="token operator"><</span><a href="accumulator-flow.html">T</a><span class="token operator">></span></div><div class="brief "><p class="paragraph">Creates <a href="-accumulator-flow/index.html">AccumulatorFlow</a> using <span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">this</span> as base <span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span></p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="2016696960%2FFunctions%2F-1457309097" anchor-label="actor" id="2016696960%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="actor.html"><span><span>actor</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2016696960%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">fun </span><span class="token operator"><</span><a href="actor.html">T</a><span class="token operator">> </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">.</span><a href="actor.html"><span class="token function">actor</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">channelCapacity<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html">Int</a><span class="token operator"> = </span>Channel.UNLIMITED<span class="token punctuation">, </span></span><span class="parameter ">block<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><a href="actor.html">T</a><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html">Unit</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines.channels/Channel///PointingToDeclaration/">Channel</span><span class="token operator"><</span><a href="actor.html">T</a><span class="token operator">></span></div><div class="brief "><p class="paragraph">Creates an actor using coroutines that processes incoming messages of type <a href="actor.html">T</a>. An actor is a computational entity that processes messages sequentially in response to messages it receives.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="2051754020%2FFunctions%2F-1457309097" anchor-label="actorAsync" id="2051754020%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="actor-async.html"><span>actor</span><wbr></wbr><span><span>Async</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2051754020%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">fun </span><span class="token operator"><</span><a href="actor-async.html">T</a><span class="token operator">> </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">.</span><a href="actor-async.html"><span class="token function">actorAsync</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">channelCapacity<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html">Int</a><span class="token operator"> = </span>Channel.UNLIMITED<span class="token punctuation">, </span></span><span class="parameter ">markerFactory<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><a href="actor-async.html">T</a><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html">Any</a><span class="token operator">?</span><span class="token operator"> = </span>{ null }<span class="token punctuation">, </span></span><span class="parameter ">logger<span class="token operator">: </span><span data-unresolved-link="dev.inmo.kslog.common/KSLog///PointingToDeclaration/">KSLog</span><span class="token operator"> = </span>KSLog<span class="token punctuation">, </span></span><span class="parameter ">block<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><a href="actor-async.html">T</a><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html">Unit</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines.channels/Channel///PointingToDeclaration/">Channel</span><span class="token operator"><</span><a href="actor-async.html">T</a><span class="token operator">></span></div><div class="brief "><p class="paragraph">Creates an actor-style channel that processes messages asynchronously based on markers. Messages with the same marker will be processed sequentially, while messages with different markers can be processed concurrently.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-242020210%2FFunctions%2F-1457309097" anchor-label="alsoWithUnlockingOnSuccess" id="-242020210%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="also-with-unlocking-on-success.html"><span>also</span><wbr></wbr><span>With</span><wbr></wbr><span>Unlocking</span><wbr></wbr><span>On</span><wbr></wbr><span><span>Success</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-242020210%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">inline suspend </span><span class="token keyword">fun </span><a href="also-with-unlocking-on-success.html"><span class="token function">alsoWithUnlockingOnSuccess</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">vararg </span>lockers<span class="token operator">: </span><a href="-smart-r-w-locker/index.html">SmartRWLocker</a><span class="token punctuation">, </span></span><span class="parameter ">block<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html">Unit</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-result/index.html">Result</a><span class="token operator"><</span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html">Unit</a><span class="token operator">></span></div><div class="brief "><p class="paragraph">Executes the given <a href="also-with-unlocking-on-success.html">block</a> and unlocks all provided <a href="also-with-unlocking-on-success.html">lockers</a> for writing if the block succeeds. If the block throws an exception, the lockers will remain locked.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-162755763%2FFunctions%2F-1457309097" anchor-label="alsoWithUnlockingOnSuccessAsync" id="-162755763%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="also-with-unlocking-on-success-async.html"><span>also</span><wbr></wbr><span>With</span><wbr></wbr><span>Unlocking</span><wbr></wbr><span>On</span><wbr></wbr><span>Success</span><wbr></wbr><span><span>Async</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-162755763%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">fun </span><a href="also-with-unlocking-on-success-async.html"><span class="token function">alsoWithUnlockingOnSuccessAsync</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">scope<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">vararg </span>lockers<span class="token operator">: </span><a href="-smart-r-w-locker/index.html">SmartRWLocker</a><span class="token punctuation">, </span></span><span class="parameter ">block<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html">Unit</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span></div><div class="brief "><p class="paragraph">Asynchronously executes the given <a href="also-with-unlocking-on-success-async.html">block</a> and unlocks all provided <a href="also-with-unlocking-on-success-async.html">lockers</a> for writing if the block succeeds. This function launches a new coroutine in the given <a href="also-with-unlocking-on-success-async.html">scope</a> and automatically logs and drops any exceptions.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="1914291283%2FFunctions%2F-1457309097" anchor-label="asyncLogging" id="1914291283%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="async-logging.html"><span>async</span><wbr></wbr><span><span>Logging</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1914291283%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">fun </span><span class="token operator"><</span><a href="async-logging.html">T</a><span class="token operator">> </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">.</span><a href="async-logging.html"><span class="token function">asyncLogging</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">errorMessageBuilder<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">.</span><span class="token punctuation">(</span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-throwable/index.html">Throwable</a><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html">Any</a><span class="token operator"> = </span>{ "Something web wrong" }<span class="token punctuation">, </span></span><span class="parameter ">logger<span class="token operator">: </span><span data-unresolved-link="dev.inmo.kslog.common/KSLog///PointingToDeclaration/">KSLog</span><span class="token operator"> = </span>KSLog<span class="token punctuation">, </span></span><span class="parameter ">context<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.coroutines/-coroutine-context/index.html">CoroutineContext</a><span class="token operator"> = </span>EmptyCoroutineContext<span class="token punctuation">, </span></span><span class="parameter ">start<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineStart///PointingToDeclaration/">CoroutineStart</span><span class="token operator"> = </span>CoroutineStart.DEFAULT<span class="token punctuation">, </span></span><span class="parameter ">block<span class="token operator">: </span><span class="token keyword">suspend </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">.</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="async-logging.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">Deferred</span><span class="token operator"><</span><a href="async-logging.html">T</a><span class="token operator">></span></div><div class="brief "><p class="paragraph">Creates a new async coroutine with automatic exception logging. If an exception occurs, it will be logged using the provided <a href="async-logging.html">logger</a> and then rethrown when the <span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">Deferred</span> is awaited.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="507001286%2FFunctions%2F-1457309097" anchor-label="asyncLoggingDropExceptions" id="507001286%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="async-logging-drop-exceptions.html"><span>async</span><wbr></wbr><span>Logging</span><wbr></wbr><span>Drop</span><wbr></wbr><span><span>Exceptions</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="507001286%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">fun </span><span class="token operator"><</span><a href="async-logging-drop-exceptions.html">T</a><span class="token operator">> </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">.</span><a href="async-logging-drop-exceptions.html"><span class="token function">asyncLoggingDropExceptions</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">errorMessageBuilder<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">.</span><span class="token punctuation">(</span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-throwable/index.html">Throwable</a><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html">Any</a><span class="token operator"> = </span>{ "Something web wrong" }<span class="token punctuation">, </span></span><span class="parameter ">logger<span class="token operator">: </span><span data-unresolved-link="dev.inmo.kslog.common/KSLog///PointingToDeclaration/">KSLog</span><span class="token operator"> = </span>KSLog<span class="token punctuation">, </span></span><span class="parameter ">context<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.coroutines/-coroutine-context/index.html">CoroutineContext</a><span class="token operator"> = </span>EmptyCoroutineContext<span class="token punctuation">, </span></span><span class="parameter ">start<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineStart///PointingToDeclaration/">CoroutineStart</span><span class="token operator"> = </span>CoroutineStart.DEFAULT<span class="token punctuation">, </span></span><span class="parameter ">block<span class="token operator">: </span><span class="token keyword">suspend </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">.</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="async-logging-drop-exceptions.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">Deferred</span><span class="token operator"><</span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-result/index.html">Result</a><span class="token operator"><</span><a href="async-logging-drop-exceptions.html">T</a><span class="token operator">></span><span class="token operator">></span></div><div class="brief "><p class="paragraph">Creates a new async coroutine with automatic exception logging and dropping. If an exception occurs, it will be logged using the provided <a href="async-logging-drop-exceptions.html">logger</a> and wrapped in a <a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-result/index.html">Result</a>, which can be checked when the <span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">Deferred</span> is awaited.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-628231384%2FFunctions%2F-1457309097" anchor-label="asyncWeak" id="-628231384%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="async-weak.html"><span>async</span><wbr></wbr><span><span>Weak</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-628231384%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">fun </span><span class="token operator"><</span><a href="async-weak.html">T</a><span class="token operator">> </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">.</span><a href="async-weak.html"><span class="token function">asyncWeak</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">context<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.coroutines/-coroutine-context/index.html">CoroutineContext</a><span class="token operator"> = </span>EmptyCoroutineContext<span class="token punctuation">, </span></span><span class="parameter ">start<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineStart///PointingToDeclaration/">CoroutineStart</span><span class="token operator"> = </span>CoroutineStart.DEFAULT<span class="token punctuation">, </span></span><span class="parameter ">block<span class="token operator">: </span><span class="token keyword">suspend </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">.</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="async-weak.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">Deferred</span><span class="token operator"><</span><a href="async-weak.html">T</a><span class="token operator">></span></div><div class="brief "><p class="paragraph"><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">this</span> will be used as base for <a href="-weak-scope.html">WeakScope</a>. Other parameters (<a href="async-weak.html">context</a>, <a href="async-weak.html">start</a>, <a href="async-weak.html">block</a>) will be used to create <span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">async</span></p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-103581439%2FFunctions%2F-1457309097" anchor-label="awaitFirst" id="-103581439%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="await-first.html"><span>await</span><wbr></wbr><span><span>First</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-103581439%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="await-first.html">T</a><span class="token operator">> </span><a href="await-first.html"><span class="token function">awaitFirst</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">vararg </span>deferreds<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">Deferred</span><span class="token operator"><</span><a href="await-first.html">T</a><span class="token operator">></span><span class="token punctuation">, </span></span><span class="parameter ">cancelOthers<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">true</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="await-first.html">T</a></div><div class="brief "><p class="paragraph">Trying to <span data-unresolved-link="kotlinx.coroutines/Deferred/await/#/PointingToDeclaration/">Deferred.await</span> on all <a href="await-first.html">deferreds</a>. The first <span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">Deferred</span> completed its work will interrupt all others awaits and, if <a href="await-first.html">cancelOthers</a> passed as true (<strong>by default</strong>), will also cancel all the others <a href="await-first.html">deferreds</a></p></div><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="await-first.html">T</a><span class="token operator">> </span><a href="await-first.html"><span class="token function">awaitFirst</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">vararg </span>deferreds<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">Deferred</span><span class="token operator"><</span><a href="await-first.html">T</a><span class="token operator">></span><span class="token punctuation">, </span></span><span class="parameter ">scope<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">, </span></span><span class="parameter ">cancelOnResult<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">true</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="await-first.html">T</a></div><div class="brief "><p class="paragraph">Trying to <span data-unresolved-link="kotlinx.coroutines/Deferred/await/#/PointingToDeclaration/">Deferred.await</span> on all <a href="await-first.html">deferreds</a>. The first <span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">Deferred</span> completed its work will interrupt all others awaits and, if <a href="await-first.html">cancelOnResult</a> passed as true (<strong>by default</strong>), will also cancel all the others <a href="await-first.html">deferreds</a></p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-1525450527%2FFunctions%2F-1457309097" anchor-label="awaitFirst" id="-1525450527%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="await-first.html"><span>await</span><wbr></wbr><span><span>First</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1525450527%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="await-first.html">T</a><span class="token operator">> </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-iterable/index.html">Iterable</a><span class="token operator"><</span><span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">Deferred</span><span class="token operator"><</span><a href="await-first.html">T</a><span class="token operator">></span><span class="token operator">></span><span class="token punctuation">.</span><a href="await-first.html"><span class="token function">awaitFirst</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">cancelOthers<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">true</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="await-first.html">T</a></div><div class="brief "><p class="paragraph">Trying to <span data-unresolved-link="kotlinx.coroutines/Deferred/await/#/PointingToDeclaration/">Deferred.await</span> on all <span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">this</span>s. The first <span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">Deferred</span> completed its work will interrupt all others awaits and, if <a href="await-first.html">cancelOthers</a> passed as true (<strong>by default</strong>), will also cancel all the others <span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">Deferred</span>s</p></div><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="await-first.html">T</a><span class="token operator">> </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-iterable/index.html">Iterable</a><span class="token operator"><</span><span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">Deferred</span><span class="token operator"><</span><a href="await-first.html">T</a><span class="token operator">></span><span class="token operator">></span><span class="token punctuation">.</span><a href="await-first.html"><span class="token function">awaitFirst</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">scope<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">, </span></span><span class="parameter ">cancelOnResult<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">true</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="await-first.html">T</a></div><div class="brief "><p class="paragraph">Trying to <span data-unresolved-link="kotlinx.coroutines/Deferred/await/#/PointingToDeclaration/">Deferred.await</span> on all <span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">this</span>s. The first <span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">Deferred</span> completed its work will interrupt all others awaits and, if <a href="await-first.html">cancelOnResult</a> passed as true (<strong>by default</strong>), will also cancel all the others <span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">Deferred</span>s</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-732129350%2FFunctions%2F-1457309097" anchor-label="awaitFirstWithDeferred" id="-732129350%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="await-first-with-deferred.html"><span>await</span><wbr></wbr><span>First</span><wbr></wbr><span>With</span><wbr></wbr><span><span>Deferred</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-732129350%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="await-first-with-deferred.html">T</a><span class="token operator">> </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-iterable/index.html">Iterable</a><span class="token operator"><</span><span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">Deferred</span><span class="token operator"><</span><a href="await-first-with-deferred.html">T</a><span class="token operator">></span><span class="token operator">></span><span class="token punctuation">.</span><a href="await-first-with-deferred.html"><span class="token function">awaitFirstWithDeferred</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">scope<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">, </span></span><span class="parameter ">cancelOnResult<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">true</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-pair/index.html">Pair</a><span class="token operator"><</span><span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">Deferred</span><span class="token operator"><</span><a href="await-first-with-deferred.html">T</a><span class="token operator">></span><span class="token punctuation">, </span><a href="await-first-with-deferred.html">T</a><span class="token operator">></span></div><div class="brief "><p class="paragraph">Trying to <span data-unresolved-link="kotlinx.coroutines/Deferred/await/#/PointingToDeclaration/">Deferred.await</span> on all <span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">this</span>s. The first <span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">Deferred</span> completed its work will interrupt all others awaits and, if <a href="await-first-with-deferred.html">cancelOnResult</a> passed as true (<strong>by default</strong>), will also cancel all the others <span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">Deferred</span>s</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="383616598%2FFunctions%2F-1457309097" anchor-label="buildAction" id="383616598%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="build-action.html"><span>build</span><wbr></wbr><span><span>Action</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="383616598%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">fun </span><span class="token operator"><</span><a href="build-action.html">T</a><span class="token punctuation">, </span><a href="build-action.html">O</a><span class="token operator">> </span><span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">Deferred</span><span class="token operator"><</span><a href="build-action.html">T</a><span class="token operator">></span><span class="token punctuation">.</span><a href="build-action.html"><span class="token function">buildAction</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">callback<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><a href="build-action.html">T</a><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="build-action.html">O</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-deferred-action/index.html">DeferredAction</a><span class="token operator"><</span><a href="build-action.html">T</a><span class="token punctuation">, </span><a href="build-action.html">O</a><span class="token operator">></span></div><div class="brief "><p class="paragraph">Creates a <a href="-deferred-action/index.html">DeferredAction</a> from this <span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">Deferred</span> and a <a href="build-action.html">callback</a> function.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="1377095834%2FFunctions%2F-1457309097" anchor-label="contextSafelyExceptionHandler" id="1377095834%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="context-safely-exception-handler.html"><span>context</span><wbr></wbr><span>Safely</span><wbr></wbr><span>Exception</span><wbr></wbr><span><span>Handler</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1377095834%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="context-safely-exception-handler.html"><span class="token function">contextSafelyExceptionHandler</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-context-safely-exception-handler/index.html">ContextSafelyExceptionHandler</a><span class="token operator">?</span></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="1924654866%2FFunctions%2F-1457309097" anchor-label="CoroutineScopeWithDefaultFallback" id="1924654866%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="-coroutine-scope-with-default-fallback.html"><span>Coroutine</span><wbr></wbr><span>Scope</span><wbr></wbr><span>With</span><wbr></wbr><span>Default</span><wbr></wbr><span><span>Fallback</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1924654866%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">fun </span><a href="-coroutine-scope-with-default-fallback.html"><span class="token function">CoroutineScopeWithDefaultFallback</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">context<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.coroutines/-coroutine-context/index.html">CoroutineContext</a><span class="token punctuation">, </span></span><span class="parameter ">defaultExceptionsHandler<span class="token operator">: </span><a href="-exception-handler/index.html">ExceptionHandler</a><span class="token operator"><</span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html">Unit</a><span class="token operator">></span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="836350220%2FFunctions%2F-1457309097" anchor-label="createActionsActor" id="836350220%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="create-actions-actor.html"><span>create</span><wbr></wbr><span>Actions</span><wbr></wbr><span><span>Actor</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="836350220%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">fun </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">.</span><a href="create-actions-actor.html"><span class="token function">createActionsActor</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines.channels/Channel///PointingToDeclaration/">Channel</span><span class="token operator"><</span><span class="token keyword">suspend </span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html">Unit</a><span class="token operator">></span></div><div class="brief "><p class="paragraph">Planned to use with <a href="do-with-suspending.html">doWithSuspending</a>. Will execute incoming lambdas sequentially</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="1172544204%2FFunctions%2F-1457309097" anchor-label="createSafeActionsActor" id="1172544204%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="create-safe-actions-actor.html"><span>create</span><wbr></wbr><span>Safe</span><wbr></wbr><span>Actions</span><wbr></wbr><span><span>Actor</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1172544204%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">.</span><a href="create-safe-actions-actor.html"><span class="token function">createSafeActionsActor</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">noinline </span>onException<span class="token operator">: </span><a href="-exception-handler/index.html">ExceptionHandler</a><span class="token operator"><</span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html">Unit</a><span class="token operator">></span><span class="token operator"> = </span>defaultSafelyExceptionHandler</span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines.channels/Channel///PointingToDeclaration/">Channel</span><span class="token operator"><</span><span class="token keyword">suspend </span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html">Unit</a><span class="token operator">></span></div><div class="brief "><p class="paragraph">Planned to use with <a href="do-with-suspending.html">doWithSuspending</a>. Will execute incoming lambdas sequentially</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="1251447643%2FFunctions%2F-1457309097" anchor-label="debouncedBy" id="1251447643%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="debounced-by.html"><span>debounced</span><wbr></wbr><span><span>By</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1251447643%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">fun </span><span class="token operator"><</span><a href="debounced-by.html">T</a><span class="token operator">> </span><span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><span class="token operator"><</span><a href="debounced-by.html">T</a><span class="token operator">></span><span class="token punctuation">.</span><a href="debounced-by.html"><span class="token function">debouncedBy</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">timeout<span class="token operator">: </span><span class="token punctuation">(</span><a href="debounced-by.html">T</a><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html">Long</a><span class="token punctuation">, </span></span><span class="parameter ">markerFactory<span class="token operator">: </span><span class="token punctuation">(</span><a href="debounced-by.html">T</a><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html">Any</a><span class="token operator">?</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><span class="token operator"><</span><a href="debounced-by.html">T</a><span class="token operator">></span></div><div class="brief "><p class="paragraph">Debounces a <span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span> with per-marker timeout control. Values with the same marker will be debounced independently. For each marker, only the last value within the timeout period will be emitted.</p></div><div class="symbol monospace"><span class="token keyword">fun </span><span class="token operator"><</span><a href="debounced-by.html">T</a><span class="token operator">> </span><span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><span class="token operator"><</span><a href="debounced-by.html">T</a><span class="token operator">></span><span class="token punctuation">.</span><a href="debounced-by.html"><span class="token function">debouncedBy</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">timeout<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html">Long</a><span class="token punctuation">, </span></span><span class="parameter ">markerFactory<span class="token operator">: </span><span class="token punctuation">(</span><a href="debounced-by.html">T</a><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html">Any</a><span class="token operator">?</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><span class="token operator"><</span><a href="debounced-by.html">T</a><span class="token operator">></span></div><div class="brief "><p class="paragraph">Debounces a <span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span> with a fixed timeout in milliseconds and per-marker control. Values with the same marker will be debounced independently.</p></div><div class="symbol monospace"><span class="token keyword">fun </span><span class="token operator"><</span><a href="debounced-by.html">T</a><span class="token operator">> </span><span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><span class="token operator"><</span><a href="debounced-by.html">T</a><span class="token operator">></span><span class="token punctuation">.</span><a href="debounced-by.html"><span class="token function">debouncedBy</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">timeout<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.time/-duration/index.html">Duration</a><span class="token punctuation">, </span></span><span class="parameter ">markerFactory<span class="token operator">: </span><span class="token punctuation">(</span><a href="debounced-by.html">T</a><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html">Any</a><span class="token operator">?</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><span class="token operator"><</span><a href="debounced-by.html">T</a><span class="token operator">></span></div><div class="brief "><p class="paragraph">Debounces a <span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span> with a fixed timeout as <a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.time/-duration/index.html">Duration</a> and per-marker control. Values with the same marker will be debounced independently.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="686320429%2FFunctions%2F-1457309097" anchor-label="doIn" id="686320429%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="do-in.html"><span>do</span><wbr></wbr><span><span>In</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="686320429%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">inline suspend </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="do-in.html">T</a><span class="token operator">> </span><a href="do-in.html"><span class="token function">doIn</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">context<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.coroutines/-coroutine-context/index.html">CoroutineContext</a><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">noinline </span>block<span class="token operator">: </span><span class="token keyword">suspend </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">.</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="do-in.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="do-in.html">T</a></div><div class="brief "><p class="paragraph">Executes the given <a href="do-in.html">block</a> in the specified coroutine <a href="do-in.html">context</a> and returns its result. This is a convenience wrapper around <span data-unresolved-link="kotlinx.coroutines//withContext/#kotlin.coroutines.CoroutineContext#kotlin.coroutines.SuspendFunction1[kotlinx.coroutines.CoroutineScope,TypeParam(bounds=[kotlin.Any?])]/PointingToDeclaration/">withContext</span>.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-548201264%2FFunctions%2F-1457309097" anchor-label="doInDefault" id="-548201264%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="do-in-default.html"><span>do</span><wbr></wbr><span>In</span><wbr></wbr><span><span>Default</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-548201264%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">inline suspend </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="do-in-default.html">T</a><span class="token operator">> </span><a href="do-in-default.html"><span class="token function">doInDefault</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">noinline </span>block<span class="token operator">: </span><span class="token keyword">suspend </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">.</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="do-in-default.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="do-in-default.html">T</a></div><div class="brief "><p class="paragraph">Executes the given <a href="do-in-default.html">block</a> on the Default dispatcher and returns its result. This is a convenience function for executing CPU-intensive operations.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="1701493701%2FFunctions%2F-1457309097" anchor-label="doInUI" id="1701493701%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="do-in-u-i.html"><span>do</span><wbr></wbr><span>In</span><wbr></wbr><span><span>UI</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1701493701%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">inline suspend </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="do-in-u-i.html">T</a><span class="token operator">> </span><a href="do-in-u-i.html"><span class="token function">doInUI</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">noinline </span>block<span class="token operator">: </span><span class="token keyword">suspend </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">.</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="do-in-u-i.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="do-in-u-i.html">T</a></div><div class="brief "><p class="paragraph">Executes the given <a href="do-in-u-i.html">block</a> on the UI/Main dispatcher and returns its result. This is a convenience function for executing UI operations.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="1538291812%2FFunctions%2F-1457309097" anchor-label="doOutsideOfCoroutine" id="1538291812%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="do-outside-of-coroutine.html"><span>do</span><wbr></wbr><span>Outside</span><wbr></wbr><span>Of</span><wbr></wbr><span><span>Coroutine</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1538291812%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="do-outside-of-coroutine.html">T</a><span class="token operator">> </span><a href="do-outside-of-coroutine.html"><span class="token function">doOutsideOfCoroutine</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">block<span class="token operator">: </span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="do-outside-of-coroutine.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="do-outside-of-coroutine.html">T</a></div><div class="brief "><p class="paragraph">Call this method in case you need to do something in common thread (like reading of file in JVM)</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="742675521%2FFunctions%2F-1457309097" anchor-label="doWithSuspending" id="742675521%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="do-with-suspending.html"><span>do</span><wbr></wbr><span>With</span><wbr></wbr><span><span>Suspending</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="742675521%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="do-with-suspending.html">T</a><span class="token operator">> </span><span data-unresolved-link="kotlinx.coroutines.channels/Channel///PointingToDeclaration/">Channel</span><span class="token operator"><</span><span class="token keyword">suspend </span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html">Unit</a><span class="token operator">></span><span class="token punctuation">.</span><a href="do-with-suspending.html"><span class="token function">doWithSuspending</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">action<span class="token operator">: </span><a href="-actor-action/index.html">ActorAction</a><span class="token operator"><</span><a href="do-with-suspending.html">T</a><span class="token operator">></span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="do-with-suspending.html">T</a></div><div class="brief "><p class="paragraph">Must be use with actor created by <a href="create-actions-actor.html">createActionsActor</a> or <a href="create-safe-actions-actor.html">createSafeActionsActor</a>. Will send lambda which will execute <a href="do-with-suspending.html">action</a> and return result.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-494032734%2FFunctions%2F-1457309097" anchor-label="filterNotNull" id="-494032734%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="filter-not-null.html"><span>filter</span><wbr></wbr><span>Not</span><wbr></wbr><span><span>Null</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-494032734%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">fun </span><span class="token operator"><</span><a href="filter-not-null.html">T</a><span class="token operator">> </span><span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><span class="token operator"><</span><a href="filter-not-null.html">T</a><span class="token operator">></span><span class="token punctuation">.</span><a href="filter-not-null.html"><span class="token function">filterNotNull</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><span class="token operator"><</span><a href="filter-not-null.html">T</a><span class="token operator"> & </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html">Any</a><span class="token operator">></span></div><div class="brief "><p class="paragraph">Alias for <a href="take-not-null.html">takeNotNull</a>. Filters out null values from this <span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span>, returning only non-null elements.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="2068150805%2FFunctions%2F-1457309097" anchor-label="first" id="2068150805%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="first.html"><span><span>first</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2068150805%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="first.html">T</a><span class="token operator">> </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator"><</span><span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">Deferred</span><span class="token operator"><</span><a href="first.html">T</a><span class="token operator">></span><span class="token operator">></span><span class="token punctuation">.</span><a href="first.html"><span class="token function">first</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">scope<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">, </span></span><span class="parameter ">cancelOnResult<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">true</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="first.html">T</a></div><div class="brief "><p class="paragraph">Returns the value of the first <span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">Deferred</span> from this list to complete, using the given <a href="first.html">scope</a>. Other deferred values are cancelled if <a href="first.html">cancelOnResult</a> is true.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-695643765%2FFunctions%2F-1457309097" anchor-label="firstNotNull" id="-695643765%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="first-not-null.html"><span>first</span><wbr></wbr><span>Not</span><wbr></wbr><span><span>Null</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-695643765%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="first-not-null.html">T</a><span class="token operator">> </span><span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><span class="token operator"><</span><a href="first-not-null.html">T</a><span class="token operator">?</span><span class="token operator">></span><span class="token punctuation">.</span><a href="first-not-null.html"><span class="token function">firstNotNull</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="first-not-null.html">T</a><span class="token operator"> & </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html">Any</a></div><div class="brief "><p class="paragraph">Returns the first non-null element emitted by this <span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span>. Suspends until a non-null element is found.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-1860243603%2FFunctions%2F-1457309097" anchor-label="firstOf" id="-1860243603%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="first-of.html"><span>first</span><wbr></wbr><span><span>Of</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1860243603%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="first-of.html">T</a><span class="token operator">> </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">.</span><a href="first-of.html"><span class="token function">firstOf</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">cancelOnResult<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">true</span><span class="token punctuation">, </span></span><span class="parameter ">block<span class="token operator">: </span><a href="-do-with-first-builder/index.html">DoWithFirstBuilder</a><span class="token operator"><</span><a href="first-of.html">T</a><span class="token operator">></span><span class="token punctuation">.</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html">Unit</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="first-of.html">T</a></div><div class="brief "><p class="paragraph">Builds multiple deferred computations using <a href="-do-with-first-builder/index.html">DoWithFirstBuilder</a> and returns the value of the first one to complete. Other deferred computations are cancelled if <a href="first-of.html">cancelOnResult</a> is true.</p></div><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="first-of.html">T</a><span class="token operator">> </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">.</span><a href="first-of.html"><span class="token function">firstOf</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">variants<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-iterable/index.html">Iterable</a><span class="token operator"><</span><span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">Deferred</span><span class="token operator"><</span><a href="first-of.html">T</a><span class="token operator">></span><span class="token operator">></span><span class="token punctuation">, </span></span><span class="parameter ">cancelOnResult<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">true</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="first-of.html">T</a></div><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="first-of.html">T</a><span class="token operator">> </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">.</span><a href="first-of.html"><span class="token function">firstOf</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">vararg </span>variants<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">Deferred</span><span class="token operator"><</span><a href="first-of.html">T</a><span class="token operator">></span><span class="token punctuation">, </span></span><span class="parameter ">cancelOnResult<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">true</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="first-of.html">T</a></div><div class="brief "><p class="paragraph">Returns the value of the first <span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">Deferred</span> from the given <a href="first-of.html">variants</a> to complete. Other deferred values are cancelled if <a href="first-of.html">cancelOnResult</a> is true.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="191908666%2FFunctions%2F-1457309097" anchor-label="flatMap" id="191908666%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="flat-map.html"><span>flat</span><wbr></wbr><span><span>Map</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="191908666%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/core/kotlin-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">"flatMapIterable"</span></span></span><wbr></wbr><span class="token punctuation">)</span></div></div><span class="token keyword">inline </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="flat-map.html">T</a><span class="token punctuation">, </span><a href="flat-map.html">R</a><span class="token operator">> </span><span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><span class="token operator"><</span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-iterable/index.html">Iterable</a><span class="token operator"><</span><a href="flat-map.html">T</a><span class="token operator">></span><span class="token operator">></span><span class="token punctuation">.</span><a href="flat-map.html"><span class="token function">flatMap</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">crossinline </span>mapper<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><a href="flat-map.html">T</a><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="flat-map.html">R</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><span class="token operator"><</span><a href="flat-map.html">R</a><span class="token operator">></span></div><div class="brief "><p class="paragraph">Transforms each element from inner <a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-iterable/index.html">Iterable</a>s using the given <a href="flat-map.html">mapper</a> function and flattens the result into a single <span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span>.</p></div><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="flat-map.html">T</a><span class="token punctuation">, </span><a href="flat-map.html">R</a><span class="token operator">> </span><span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><span class="token operator"><</span><span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><span class="token operator"><</span><a href="flat-map.html">T</a><span class="token operator">></span><span class="token operator">></span><span class="token punctuation">.</span><a href="flat-map.html"><span class="token function">flatMap</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">crossinline </span>mapper<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><a href="flat-map.html">T</a><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="flat-map.html">R</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><span class="token operator"><</span><a href="flat-map.html">R</a><span class="token operator">></span></div><div class="brief "><p class="paragraph">Transforms each inner <span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span> element using the given <a href="flat-map.html">mapper</a> function and flattens the result into a single <span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span>.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="1194898510%2FFunctions%2F-1457309097" anchor-label="flatMapNotNull" id="1194898510%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="flat-map-not-null.html"><span>flat</span><wbr></wbr><span>Map</span><wbr></wbr><span>Not</span><wbr></wbr><span><span>Null</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1194898510%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/core/kotlin-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">"flatMapNotNullIterable"</span></span></span><wbr></wbr><span class="token punctuation">)</span></div></div><span class="token keyword">inline </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="flat-map-not-null.html">T</a><span class="token punctuation">, </span><a href="flat-map-not-null.html">R</a><span class="token operator">> </span><span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><span class="token operator"><</span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-iterable/index.html">Iterable</a><span class="token operator"><</span><a href="flat-map-not-null.html">T</a><span class="token operator">></span><span class="token operator">></span><span class="token punctuation">.</span><a href="flat-map-not-null.html"><span class="token function">flatMapNotNull</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">crossinline </span>mapper<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><a href="flat-map-not-null.html">T</a><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="flat-map-not-null.html">R</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><span class="token operator"><</span><a href="flat-map-not-null.html">R</a><span class="token operator"> & </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html">Any</a><span class="token operator">></span></div><div class="brief "><p class="paragraph">Transforms each element from inner <a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-iterable/index.html">Iterable</a>s using the given <a href="flat-map-not-null.html">mapper</a> function, flattens the result, and filters out null values.</p></div><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="flat-map-not-null.html">T</a><span class="token punctuation">, </span><a href="flat-map-not-null.html">R</a><span class="token operator">> </span><span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><span class="token operator"><</span><span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><span class="token operator"><</span><a href="flat-map-not-null.html">T</a><span class="token operator">></span><span class="token operator">></span><span class="token punctuation">.</span><a href="flat-map-not-null.html"><span class="token function">flatMapNotNull</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">crossinline </span>mapper<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><a href="flat-map-not-null.html">T</a><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="flat-map-not-null.html">R</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><span class="token operator"><</span><a href="flat-map-not-null.html">R</a><span class="token operator"> & </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html">Any</a><span class="token operator">></span></div><div class="brief "><p class="paragraph">Transforms each inner <span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span> element using the given <a href="flat-map-not-null.html">mapper</a> function, flattens the result, and filters out null values.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="224796620%2FFunctions%2F-1457309097" anchor-label="flatten" id="224796620%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="flatten.html"><span><span>flatten</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="224796620%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/core/kotlin-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">"flattenIterable"</span></span></span><wbr></wbr><span class="token punctuation">)</span></div></div><span class="token keyword">fun </span><span class="token operator"><</span><a href="flatten.html">T</a><span class="token operator">> </span><span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><span class="token operator"><</span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-iterable/index.html">Iterable</a><span class="token operator"><</span><a href="flatten.html">T</a><span class="token operator">></span><span class="token operator">></span><span class="token punctuation">.</span><a href="flatten.html"><span class="token function">flatten</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><span class="token operator"><</span><a href="flatten.html">T</a><span class="token operator">></span></div><div class="brief "><p class="paragraph">Flattens a <span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span> of <a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-iterable/index.html">Iterable</a>s into a single <span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span> by emitting all elements from each iterable.</p></div><div class="symbol monospace"><span class="token keyword">fun </span><span class="token operator"><</span><a href="flatten.html">T</a><span class="token operator">> </span><span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><span class="token operator"><</span><span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><span class="token operator"><</span><a href="flatten.html">T</a><span class="token operator">></span><span class="token operator">></span><span class="token punctuation">.</span><a href="flatten.html"><span class="token function">flatten</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><span class="token operator"><</span><a href="flatten.html">T</a><span class="token operator">></span></div><div class="brief "><p class="paragraph">Flattens a <span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span> of <span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span>s into a single <span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span> by collecting all inner flows sequentially.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="231537345%2FFunctions%2F-1457309097" anchor-label="invoke" id="231537345%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="invoke.html"><span><span>invoke</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="231537345%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">inline suspend operator </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="invoke.html">T</a><span class="token operator">> </span><span data-unresolved-link="kotlinx.coroutines.flow/FlowCollector///PointingToDeclaration/">FlowCollector</span><span class="token operator"><</span><a href="invoke.html">T</a><span class="token operator">></span><span class="token punctuation">.</span><a href="invoke.html"><span class="token function">invoke</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">value<span class="token operator">: </span><a href="invoke.html">T</a></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Operator function that allows a <span data-unresolved-link="kotlinx.coroutines.flow/FlowCollector///PointingToDeclaration/">FlowCollector</span> to be invoked like a function to emit a value. This is a convenient syntax sugar for <span data-unresolved-link="kotlinx.coroutines.flow/FlowCollector/emit/#TypeParam(bounds=[kotlin.Any?])/PointingToDeclaration/">FlowCollector.emit</span>.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="2050807892%2FFunctions%2F-1457309097" anchor-label="invokeFirstOf" id="2050807892%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="invoke-first-of.html"><span>invoke</span><wbr></wbr><span>First</span><wbr></wbr><span><span>Of</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2050807892%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="invoke-first-of.html">O</a><span class="token operator">> </span><a href="invoke-first-of.html"><span class="token function">invokeFirstOf</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">scope<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">vararg </span>variants<span class="token operator">: </span><a href="-deferred-action/index.html">DeferredAction</a><span class="token operator"><</span><span class="token operator">*</span><span class="token punctuation">, </span><a href="invoke-first-of.html">O</a><span class="token operator">></span><span class="token punctuation">, </span></span><span class="parameter ">cancelOnResult<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">true</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="invoke-first-of.html">O</a></div><div class="brief "><p class="paragraph">Invokes the first <a href="-deferred-action/index.html">DeferredAction</a> from the given <a href="invoke-first-of.html">variants</a> whose deferred value completes, executing its callback and returning the result. Other deferred actions are cancelled if <a href="invoke-first-of.html">cancelOnResult</a> is true.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-211144107%2FFunctions%2F-1457309097" anchor-label="invokeFirstOf" id="-211144107%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="invoke-first-of.html"><span>invoke</span><wbr></wbr><span>First</span><wbr></wbr><span><span>Of</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-211144107%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="invoke-first-of.html">O</a><span class="token operator">> </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-iterable/index.html">Iterable</a><span class="token operator"><</span><a href="-deferred-action/index.html">DeferredAction</a><span class="token operator"><</span><span class="token operator">*</span><span class="token punctuation">, </span><a href="invoke-first-of.html">O</a><span class="token operator">></span><span class="token operator">></span><span class="token punctuation">.</span><a href="invoke-first-of.html"><span class="token function">invokeFirstOf</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">scope<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">, </span></span><span class="parameter ">cancelOnResult<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">true</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="invoke-first-of.html">O</a></div><div class="brief "><p class="paragraph">Invokes the first <a href="-deferred-action/index.html">DeferredAction</a> whose deferred value completes, executing its callback and returning the result. Other deferred actions are cancelled if <a href="invoke-first-of.html">cancelOnResult</a> is true.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="931270859%2FFunctions%2F-1457309097" anchor-label="invokeOnFirst" id="931270859%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="invoke-on-first.html"><span>invoke</span><wbr></wbr><span>On</span><wbr></wbr><span><span>First</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="931270859%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="invoke-on-first.html">T</a><span class="token punctuation">, </span><a href="invoke-on-first.html">O</a><span class="token operator">> </span><a href="invoke-on-first.html"><span class="token function">invokeOnFirst</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">scope<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">vararg </span>variants<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">Deferred</span><span class="token operator"><</span><a href="invoke-on-first.html">T</a><span class="token operator">></span><span class="token punctuation">, </span></span><span class="parameter ">cancelOnResult<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">true</span><span class="token punctuation">, </span></span><span class="parameter ">callback<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><a href="invoke-on-first.html">T</a><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="invoke-on-first.html">O</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="invoke-on-first.html">O</a></div><div class="brief "><p class="paragraph">Awaits the first <span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">Deferred</span> from the given <a href="invoke-on-first.html">variants</a> to complete and invokes the <a href="invoke-on-first.html">callback</a> on its value. Other deferred values are cancelled if <a href="invoke-on-first.html">cancelOnResult</a> is true.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-3055716%2FFunctions%2F-1457309097" anchor-label="invokeOnFirst" id="-3055716%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="invoke-on-first.html"><span>invoke</span><wbr></wbr><span>On</span><wbr></wbr><span><span>First</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-3055716%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="invoke-on-first.html">T</a><span class="token punctuation">, </span><a href="invoke-on-first.html">O</a><span class="token operator">> </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-iterable/index.html">Iterable</a><span class="token operator"><</span><span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">Deferred</span><span class="token operator"><</span><a href="invoke-on-first.html">T</a><span class="token operator">></span><span class="token operator">></span><span class="token punctuation">.</span><a href="invoke-on-first.html"><span class="token function">invokeOnFirst</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">scope<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">, </span></span><span class="parameter ">cancelOnResult<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">true</span><span class="token punctuation">, </span></span><span class="parameter ">callback<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><a href="invoke-on-first.html">T</a><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="invoke-on-first.html">O</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="invoke-on-first.html">O</a></div><div class="brief "><p class="paragraph">Awaits the first <span data-unresolved-link="kotlinx.coroutines/Deferred///PointingToDeclaration/">Deferred</span> to complete and invokes the <a href="invoke-on-first.html">callback</a> on its value. Other deferred values are cancelled if <a href="invoke-on-first.html">cancelOnResult</a> is true.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-871336644%2FFunctions%2F-1457309097" anchor-label="invokeOnFirstOf" id="-871336644%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="invoke-on-first-of.html"><span>invoke</span><wbr></wbr><span>On</span><wbr></wbr><span>First</span><wbr></wbr><span><span>Of</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-871336644%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="invoke-on-first-of.html">T</a><span class="token punctuation">, </span><a href="invoke-on-first-of.html">O</a><span class="token operator">> </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">.</span><a href="invoke-on-first-of.html"><span class="token function">invokeOnFirstOf</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">cancelOnResult<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">true</span><span class="token punctuation">, </span></span><span class="parameter ">block<span class="token operator">: </span><a href="-do-with-first-builder/index.html">DoWithFirstBuilder</a><span class="token operator"><</span><a href="invoke-on-first-of.html">T</a><span class="token operator">></span><span class="token punctuation">.</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html">Unit</a><span class="token punctuation">, </span></span><span class="parameter ">callback<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><a href="invoke-on-first-of.html">T</a><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="invoke-on-first-of.html">O</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="invoke-on-first-of.html">O</a></div><div class="brief "><p class="paragraph">Builds multiple deferred computations using <a href="-do-with-first-builder/index.html">DoWithFirstBuilder</a> and invokes <a href="invoke-on-first-of.html">callback</a> on the first one to complete. Other deferred computations are cancelled if <a href="invoke-on-first-of.html">cancelOnResult</a> is true.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-155727745%2FFunctions%2F-1457309097" anchor-label="joinFirst" id="-155727745%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="join-first.html"><span>join</span><wbr></wbr><span><span>First</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-155727745%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="join-first.html"><span class="token function">joinFirst</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">vararg </span>jobs<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span><span class="token punctuation">, </span></span><span class="parameter ">cancelOthers<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">true</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span></div><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="join-first.html"><span class="token function">joinFirst</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">vararg </span>jobs<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span><span class="token punctuation">, </span></span><span class="parameter ">scope<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">, </span></span><span class="parameter ">cancelOthers<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">true</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span></div><div class="brief "><p class="paragraph">Trying to <span data-unresolved-link="kotlinx.coroutines/Job/join/#/PointingToDeclaration/">Job.join</span> on all <a href="join-first.html">jobs</a>. The first <span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span> completed its work will interrupt all others joins and, if <a href="join-first.html">cancelOthers</a> passed as true (<strong>by default</strong>), will also cancel all the others <span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span>s</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-1384378675%2FFunctions%2F-1457309097" anchor-label="joinFirst" id="-1384378675%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="join-first.html"><span>join</span><wbr></wbr><span><span>First</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1384378675%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-iterable/index.html">Iterable</a><span class="token operator"><</span><span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span><span class="token operator">></span><span class="token punctuation">.</span><a href="join-first.html"><span class="token function">joinFirst</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">cancelOthers<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">true</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span></div><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-iterable/index.html">Iterable</a><span class="token operator"><</span><span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span><span class="token operator">></span><span class="token punctuation">.</span><a href="join-first.html"><span class="token function">joinFirst</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">scope<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">, </span></span><span class="parameter ">cancelOthers<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">true</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span></div><div class="brief "><p class="paragraph">Trying to <span data-unresolved-link="kotlinx.coroutines/Job/join/#/PointingToDeclaration/">Job.join</span> on all <span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">this</span>s. The first <span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span> completed its work will interrupt all others joins and, if <a href="join-first.html">cancelOthers</a> passed as true (<strong>by default</strong>), will also cancel all the others <span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span>s</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-921990713%2FFunctions%2F-1457309097" anchor-label="launchLogging" id="-921990713%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="launch-logging.html"><span>launch</span><wbr></wbr><span><span>Logging</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-921990713%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">fun </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">.</span><a href="launch-logging.html"><span class="token function">launchLogging</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">errorMessageBuilder<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">.</span><span class="token punctuation">(</span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-throwable/index.html">Throwable</a><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html">Any</a><span class="token operator"> = </span>{ "Something web wrong" }<span class="token punctuation">, </span></span><span class="parameter ">logger<span class="token operator">: </span><span data-unresolved-link="dev.inmo.kslog.common/KSLog///PointingToDeclaration/">KSLog</span><span class="token operator"> = </span>KSLog<span class="token punctuation">, </span></span><span class="parameter ">context<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.coroutines/-coroutine-context/index.html">CoroutineContext</a><span class="token operator"> = </span>EmptyCoroutineContext<span class="token punctuation">, </span></span><span class="parameter ">start<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineStart///PointingToDeclaration/">CoroutineStart</span><span class="token operator"> = </span>CoroutineStart.DEFAULT<span class="token punctuation">, </span></span><span class="parameter ">block<span class="token operator">: </span><span class="token keyword">suspend </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">.</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html">Unit</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span></div><div class="brief "><p class="paragraph">Launches a new coroutine with automatic exception logging. If an exception occurs, it will be logged using the provided <a href="launch-logging.html">logger</a> and then rethrown.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-1992429958%2FFunctions%2F-1457309097" anchor-label="launchLoggingDropExceptions" id="-1992429958%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="launch-logging-drop-exceptions.html"><span>launch</span><wbr></wbr><span>Logging</span><wbr></wbr><span>Drop</span><wbr></wbr><span><span>Exceptions</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1992429958%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">fun </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">.</span><a href="launch-logging-drop-exceptions.html"><span class="token function">launchLoggingDropExceptions</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">errorMessageBuilder<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">.</span><span class="token punctuation">(</span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-throwable/index.html">Throwable</a><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html">Any</a><span class="token operator"> = </span>{ "Something web wrong" }<span class="token punctuation">, </span></span><span class="parameter ">logger<span class="token operator">: </span><span data-unresolved-link="dev.inmo.kslog.common/KSLog///PointingToDeclaration/">KSLog</span><span class="token operator"> = </span>KSLog<span class="token punctuation">, </span></span><span class="parameter ">context<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.coroutines/-coroutine-context/index.html">CoroutineContext</a><span class="token operator"> = </span>EmptyCoroutineContext<span class="token punctuation">, </span></span><span class="parameter ">start<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineStart///PointingToDeclaration/">CoroutineStart</span><span class="token operator"> = </span>CoroutineStart.DEFAULT<span class="token punctuation">, </span></span><span class="parameter ">block<span class="token operator">: </span><span class="token keyword">suspend </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">.</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html">Unit</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span></div><div class="brief "><p class="paragraph">Launches a new coroutine with automatic exception logging and dropping. If an exception occurs, it will be logged using the provided <a href="launch-logging-drop-exceptions.html">logger</a> and then dropped (not rethrown), allowing the coroutine to complete normally.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-1130956946%2FFunctions%2F-1457309097" anchor-label="launchWeak" id="-1130956946%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="launch-weak.html"><span>launch</span><wbr></wbr><span><span>Weak</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1130956946%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">fun </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">.</span><a href="launch-weak.html"><span class="token function">launchWeak</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">context<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.coroutines/-coroutine-context/index.html">CoroutineContext</a><span class="token operator"> = </span>EmptyCoroutineContext<span class="token punctuation">, </span></span><span class="parameter ">start<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineStart///PointingToDeclaration/">CoroutineStart</span><span class="token operator"> = </span>CoroutineStart.DEFAULT<span class="token punctuation">, </span></span><span class="parameter ">block<span class="token operator">: </span><span class="token keyword">suspend </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">.</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html">Unit</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span></div><div class="brief "><p class="paragraph"><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">this</span> will be used as base for <a href="-weak-scope.html">WeakScope</a>. Other parameters (<a href="launch-weak.html">context</a>, <a href="launch-weak.html">start</a>, <a href="launch-weak.html">block</a>) will be used to <span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">launch</span></p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-1880810631%2FFunctions%2F-1457309097" anchor-label="LinkedSupervisorJob" id="-1880810631%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="-linked-supervisor-job.html"><span>Linked</span><wbr></wbr><span>Supervisor</span><wbr></wbr><span><span>Job</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1880810631%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">fun </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.coroutines/-coroutine-context/index.html">CoroutineContext</a><span class="token punctuation">.</span><a href="-linked-supervisor-job.html"><span class="token function">LinkedSupervisorJob</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">additionalContext<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.coroutines/-coroutine-context/index.html">CoroutineContext</a><span class="token operator">?</span><span class="token operator"> = </span>null</span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.coroutines/-coroutine-context/index.html">CoroutineContext</a></div><div class="brief "><p class="paragraph">Creates a <span data-unresolved-link="kotlinx.coroutines//SupervisorJob/#kotlinx.coroutines.Job?/PointingToDeclaration/">SupervisorJob</span> linked to this <a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.coroutines/-coroutine-context/index.html">CoroutineContext</a>'s job. The new supervisor job will be a child of the current job, and optionally combined with <a href="-linked-supervisor-job.html">additionalContext</a>.</p></div><div class="symbol monospace"><span class="token keyword">fun </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">.</span><a href="-linked-supervisor-job.html"><span class="token function">LinkedSupervisorJob</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">additionalContext<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.coroutines/-coroutine-context/index.html">CoroutineContext</a><span class="token operator">?</span><span class="token operator"> = </span>null</span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.coroutines/-coroutine-context/index.html">CoroutineContext</a></div><div class="brief "><p class="paragraph">Creates a <span data-unresolved-link="kotlinx.coroutines//SupervisorJob/#kotlinx.coroutines.Job?/PointingToDeclaration/">SupervisorJob</span> linked to this <span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span>'s job. The new supervisor job will be a child of the current scope's job, and optionally combined with <a href="-linked-supervisor-job.html">additionalContext</a>.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="1634138251%2FFunctions%2F-1457309097" anchor-label="LinkedSupervisorScope" id="1634138251%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="-linked-supervisor-scope.html"><span>Linked</span><wbr></wbr><span>Supervisor</span><wbr></wbr><span><span>Scope</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1634138251%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">fun </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.coroutines/-coroutine-context/index.html">CoroutineContext</a><span class="token punctuation">.</span><a href="-linked-supervisor-scope.html"><span class="token function">LinkedSupervisorScope</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">additionalContext<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.coroutines/-coroutine-context/index.html">CoroutineContext</a><span class="token operator">?</span><span class="token operator"> = </span>null</span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span></div><div class="brief "><p class="paragraph">Creates a new <span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span> with a <span data-unresolved-link="kotlinx.coroutines//SupervisorJob/#kotlinx.coroutines.Job?/PointingToDeclaration/">SupervisorJob</span> linked to this <a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.coroutines/-coroutine-context/index.html">CoroutineContext</a>'s job. The new scope's supervisor job will be a child of the current job, and optionally combined with <a href="-linked-supervisor-scope.html">additionalContext</a>.</p></div><div class="symbol monospace"><span class="token keyword">fun </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">.</span><a href="-linked-supervisor-scope.html"><span class="token function">LinkedSupervisorScope</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">additionalContext<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.coroutines/-coroutine-context/index.html">CoroutineContext</a><span class="token operator">?</span><span class="token operator"> = </span>null</span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span></div><div class="brief "><p class="paragraph">Creates a new <span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span> with a <span data-unresolved-link="kotlinx.coroutines//SupervisorJob/#kotlinx.coroutines.Job?/PointingToDeclaration/">SupervisorJob</span> linked to this <span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span>'s job. The new scope's supervisor job will be a child of the current scope's job, and optionally combined with <a href="-linked-supervisor-scope.html">additionalContext</a>.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="1369270532%2FFunctions%2F-1457309097" anchor-label="plus" id="1369270532%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="plus.html"><span><span>plus</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1369270532%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">inline operator </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="plus.html">T</a><span class="token operator">> </span><span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><span class="token operator"><</span><a href="plus.html">T</a><span class="token operator">></span><span class="token punctuation">.</span><a href="plus.html"><span class="token function">plus</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">other<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><span class="token operator"><</span><a href="plus.html">T</a><span class="token operator">></span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><span class="token operator"><</span><a href="plus.html">T</a><span class="token operator">></span></div><div class="brief "><p class="paragraph">Merges two flows into a single flow. Values from both flows will be emitted as they become available. This is a convenient operator syntax for <span data-unresolved-link="kotlinx.coroutines.flow//merge/kotlinx.coroutines.flow.Flow[kotlinx.coroutines.flow.Flow[TypeParam(bounds=[kotlin.Any?])]]#/PointingToDeclaration/">merge</span>.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="1978898202%2FFunctions%2F1069517945" anchor-label="preloadImage" id="1978898202%2FFunctions%2F1069517945" data-filterable-set=":micro_utils.dokka/jsMain"></a>
|
|
<div class="table-row table-row_content" data-filterable-current=":micro_utils.dokka/jsMain" data-filterable-set=":micro_utils.dokka/jsMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="preload-image.html"><span>preload</span><wbr></wbr><span><span>Image</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1978898202%2FFunctions%2F1069517945"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<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=":micro_utils.dokka/jsMain" data-filterable-set=":micro_utils.dokka/jsMain" data-active="" data-toggle=":micro_utils.dokka/jsMain">js</button></div>
|
|
<div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/jsMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="preload-image.html"><span class="token function">preloadImage</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">src<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/org.w3c.dom/-image/index.html">Image</a></div></div> </div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-1209998326%2FFunctions%2F-1457309097" anchor-label="replaceIfFailure" id="-1209998326%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="replace-if-failure.html"><span>replace</span><wbr></wbr><span>If</span><wbr></wbr><span><span>Failure</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1209998326%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="replace-if-failure.html">T</a><span class="token operator">> </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-result/index.html">Result</a><span class="token operator"><</span><a href="replace-if-failure.html">T</a><span class="token operator">></span><span class="token punctuation">.</span><a href="replace-if-failure.html"><span class="token function">replaceIfFailure</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">onException<span class="token operator">: </span><span class="token punctuation">(</span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-throwable/index.html">Throwable</a><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="replace-if-failure.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-result/index.html">Result</a><span class="token operator"><</span><a href="replace-if-failure.html">T</a><span class="token operator">></span></div><div class="brief "><p class="paragraph">Replaces a failed <a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-result/index.html">Result</a> with a new value computed from the exception. If this <a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-result/index.html">Result</a> is successful, it is returned as-is. If it represents a failure, the <a href="replace-if-failure.html">onException</a> handler is called with the exception to compute a replacement value, which is then wrapped in a new <a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-result/index.html">Result</a>.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-547382093%2FFunctions%2F-1457309097" anchor-label="runCatchingLogging" id="-547382093%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="run-catching-logging.html"><span>run</span><wbr></wbr><span>Catching</span><wbr></wbr><span><span>Logging</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-547382093%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="run-catching-logging.html">T</a><span class="token punctuation">, </span><a href="run-catching-logging.html">R</a><span class="token operator">> </span><a href="run-catching-logging.html">R</a><span class="token punctuation">.</span><a href="run-catching-logging.html"><span class="token function">runCatchingLogging</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">noinline </span>errorMessageBuilder<span class="token operator">: </span><a href="run-catching-logging.html">R</a><span class="token punctuation">.</span><span class="token punctuation">(</span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-throwable/index.html">Throwable</a><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html">Any</a><span class="token operator"> = </span>{ "Something web wrong" }<span class="token punctuation">, </span></span><span class="parameter ">logger<span class="token operator">: </span><span data-unresolved-link="dev.inmo.kslog.common/KSLog///PointingToDeclaration/">KSLog</span><span class="token operator"> = </span>KSLog<span class="token punctuation">, </span></span><span class="parameter ">block<span class="token operator">: </span><a href="run-catching-logging.html">R</a><span class="token punctuation">.</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="run-catching-logging.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-result/index.html">Result</a><span class="token operator"><</span><a href="run-catching-logging.html">T</a><span class="token operator">></span></div><div class="brief "><p class="paragraph">Executes the given <a href="run-catching-logging.html">block</a> within a <code class="lang-kotlin">runCatching</code> context and logs any exceptions that occur, excluding <code class="lang-kotlin">CancellationException</code> which is rethrown. This method simplifies error handling by automatically logging the errors using the provided <a href="run-catching-logging.html">logger</a>.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="1701246477%2FFunctions%2F-1457309097" anchor-label="safeActor" id="1701246477%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="safe-actor.html"><span>safe</span><wbr></wbr><span><span>Actor</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1701246477%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="safe-actor.html">T</a><span class="token operator">> </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">.</span><a href="safe-actor.html"><span class="token function">safeActor</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">channelCapacity<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html">Int</a><span class="token operator"> = </span>Channel.UNLIMITED<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">noinline </span>onException<span class="token operator">: </span><a href="-exception-handler/index.html">ExceptionHandler</a><span class="token operator"><</span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html">Unit</a><span class="token operator">></span><span class="token operator"> = </span>defaultSafelyExceptionHandler<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">crossinline </span>block<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><a href="safe-actor.html">T</a><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html">Unit</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines.channels/Channel///PointingToDeclaration/">Channel</span><span class="token operator"><</span><a href="safe-actor.html">T</a><span class="token operator">></span></div><div class="brief "><p class="paragraph">Creates a safe actor that catches and handles exceptions during message processing. This variant wraps the processing logic in a safety mechanism to prevent actor failure due to exceptions.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-77540034%2FFunctions%2F1069517945" anchor-label="selectFileOrNull" id="-77540034%2FFunctions%2F1069517945" data-filterable-set=":micro_utils.dokka/jsMain"></a>
|
|
<div class="table-row table-row_content" data-filterable-current=":micro_utils.dokka/jsMain" data-filterable-set=":micro_utils.dokka/jsMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="select-file-or-null.html"><span>select</span><wbr></wbr><span>File</span><wbr></wbr><span>Or</span><wbr></wbr><span><span>Null</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-77540034%2FFunctions%2F1069517945"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<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=":micro_utils.dokka/jsMain" data-filterable-set=":micro_utils.dokka/jsMain" data-active="" data-toggle=":micro_utils.dokka/jsMain">js</button></div>
|
|
<div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/jsMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="select-file-or-null.html"><span class="token function">selectFileOrNull</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">inputSetup<span class="token operator">: </span><span class="token punctuation">(</span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/org.w3c.dom/-h-t-m-l-input-element/index.html">HTMLInputElement</a><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html">Unit</a><span class="token operator"> = </span>{}<span class="token punctuation">, </span></span><span class="parameter ">onFailure<span class="token operator">: </span><span class="token punctuation">(</span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-throwable/index.html">Throwable</a><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="https://kotlinlang.org/api/core/kotlin-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="../dev.inmo.micro_utils.common/-m-p-p-file/index.html#1311967782%2FMain%2F1069517945">MPPFile</a><span class="token operator">?</span></div></div> </div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="1675948644%2FFunctions%2F1069517945" anchor-label="selectFileOrThrow" id="1675948644%2FFunctions%2F1069517945" data-filterable-set=":micro_utils.dokka/jsMain"></a>
|
|
<div class="table-row table-row_content" data-filterable-current=":micro_utils.dokka/jsMain" data-filterable-set=":micro_utils.dokka/jsMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="select-file-or-throw.html"><span>select</span><wbr></wbr><span>File</span><wbr></wbr><span>Or</span><wbr></wbr><span><span>Throw</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1675948644%2FFunctions%2F1069517945"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<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=":micro_utils.dokka/jsMain" data-filterable-set=":micro_utils.dokka/jsMain" data-active="" data-toggle=":micro_utils.dokka/jsMain">js</button></div>
|
|
<div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/jsMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="select-file-or-throw.html"><span class="token function">selectFileOrThrow</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">inputSetup<span class="token operator">: </span><span class="token punctuation">(</span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/org.w3c.dom/-h-t-m-l-input-element/index.html">HTMLInputElement</a><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="https://kotlinlang.org/api/core/kotlin-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="../dev.inmo.micro_utils.common/-m-p-p-file/index.html#1311967782%2FMain%2F1069517945">MPPFile</a></div></div> </div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-809554133%2FFunctions%2F102564003" anchor-label="setOnHierarchyChangeListenerRecursively" id="-809554133%2FFunctions%2F102564003" data-filterable-set=":micro_utils.dokka/androidMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/androidMain" data-filterable-set=":micro_utils.dokka/androidMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="set-on-hierarchy-change-listener-recursively.html"><span>set</span><wbr></wbr><span>On</span><wbr></wbr><span>Hierarchy</span><wbr></wbr><span>Change</span><wbr></wbr><span>Listener</span><wbr></wbr><span><span>Recursively</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-809554133%2FFunctions%2F102564003"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<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=":micro_utils.dokka/androidMain" data-filterable-set=":micro_utils.dokka/androidMain" data-active="" data-toggle=":micro_utils.dokka/androidMain">android</button></div>
|
|
<div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/androidMain"><div class="symbol monospace"><span class="token keyword">fun </span><a href="https://developer.android.com/reference/kotlin/android/view/ViewGroup.html">ViewGroup</a><span class="token punctuation">.</span><a href="set-on-hierarchy-change-listener-recursively.html"><span class="token function">setOnHierarchyChangeListenerRecursively</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">listener<span class="token operator">: </span><a href="https://developer.android.com/reference/kotlin/android/view/ViewGroup.OnHierarchyChangeListener.html">ViewGroup.OnHierarchyChangeListener</a></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Use <a href="https://developer.android.com/reference/kotlin/android/view/ViewGroup.html#setonhierarchychangelistener">ViewGroup.setOnHierarchyChangeListener</a> recursively for all available <a href="https://developer.android.com/reference/kotlin/android/view/ViewGroup.html">ViewGroup</a>s starting with <a href="https://developer.android.com/reference/kotlin/android/view/ViewGroup.html">this</a>. This extension DO NOT guarantee that recursive subscription will happen after this method call</p></div></div> </div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-905659017%2FFunctions%2F-1457309097" anchor-label="subscribe" id="-905659017%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="subscribe.html"><span><span>subscribe</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-905659017%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="subscribe.html">T</a><span class="token operator">> </span><span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><span class="token operator"><</span><a href="subscribe.html">T</a><span class="token operator">></span><span class="token punctuation">.</span><a href="subscribe.html"><span class="token function">subscribe</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">scope<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">noinline </span>block<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><a href="subscribe.html">T</a><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html">Unit</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span></div><div class="brief "><p class="paragraph">Shortcut for chain if <span data-unresolved-link="kotlinx.coroutines.flow//onEach/kotlinx.coroutines.flow.Flow[TypeParam(bounds=[kotlin.Any?])]#kotlin.coroutines.SuspendFunction1[TypeParam(bounds=[kotlin.Any?]),kotlin.Unit]/PointingToDeclaration/">Flow.onEach</span> and <span data-unresolved-link="kotlinx.coroutines.flow//launchIn/kotlinx.coroutines.flow.Flow[TypeParam(bounds=[kotlin.Any?])]#kotlinx.coroutines.CoroutineScope/PointingToDeclaration/">Flow.launchIn</span></p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-224878079%2FFunctions%2F-1457309097" anchor-label="subscribeAsync" id="-224878079%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="subscribe-async.html"><span>subscribe</span><wbr></wbr><span><span>Async</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-224878079%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">fun </span><span class="token operator"><</span><a href="subscribe-async.html">T</a><span class="token punctuation">, </span><a href="subscribe-async.html">M</a><span class="token operator">> </span><span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><span class="token operator"><</span><a href="subscribe-async.html">T</a><span class="token operator">></span><span class="token punctuation">.</span><a href="subscribe-async.html"><span class="token function">subscribeAsync</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">scope<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">, </span></span><span class="parameter ">markerFactory<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><a href="subscribe-async.html">T</a><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="subscribe-async.html">M</a><span class="token punctuation">, </span></span><span class="parameter ">logger<span class="token operator">: </span><span data-unresolved-link="dev.inmo.kslog.common/KSLog///PointingToDeclaration/">KSLog</span><span class="token operator"> = </span>KSLog<span class="token punctuation">, </span></span><span class="parameter ">block<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><a href="subscribe-async.html">T</a><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html">Unit</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span></div><div class="brief "><p class="paragraph">Subscribes to a <span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span> with asynchronous processing based on markers. Each value from the flow will be processed by the <a href="subscribe-async.html">block</a> function. Values with the same marker will be processed sequentially in the same coroutine scope, while values with different markers can be processed concurrently in separate coroutine scopes.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="1915944476%2FFunctions%2F-1457309097" anchor-label="subscribeLogging" id="1915944476%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="subscribe-logging.html"><span>subscribe</span><wbr></wbr><span><span>Logging</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1915944476%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="subscribe-logging.html">T</a><span class="token operator">> </span><span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><span class="token operator"><</span><a href="subscribe-logging.html">T</a><span class="token operator">></span><span class="token punctuation">.</span><a href="subscribe-logging.html"><span class="token function">subscribeLogging</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">scope<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">noinline </span>errorMessageBuilder<span class="token operator">: </span><a href="subscribe-logging.html">T</a><span class="token punctuation">.</span><span class="token punctuation">(</span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-throwable/index.html">Throwable</a><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html">Any</a><span class="token operator"> = </span>{ "Something web wrong" }<span class="token punctuation">, </span></span><span class="parameter ">logger<span class="token operator">: </span><span data-unresolved-link="dev.inmo.kslog.common/KSLog///PointingToDeclaration/">KSLog</span><span class="token operator"> = </span>KSLog<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">noinline </span>block<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><a href="subscribe-logging.html">T</a><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html">Unit</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span></div><div class="brief "><p class="paragraph">Use <a href="subscribe.html">subscribe</a>, but all <a href="subscribe-logging.html">block</a>s will be called inside of <span data-unresolved-link="dev.inmo.micro_utils.coroutines//safely/#kotlin.coroutines.SuspendFunction1[kotlin.Throwable,TypeParam(bounds=[kotlin.Any?])]#kotlin.coroutines.SuspendFunction0[TypeParam(bounds=[kotlin.Any?])]/PointingToDeclaration/">safely</span> function. Use onException to set up your reaction for <a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-throwable/index.html">Throwable</a>s</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="955173513%2FFunctions%2F-1457309097" anchor-label="subscribeLoggingDropExceptions" id="955173513%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="subscribe-logging-drop-exceptions.html"><span>subscribe</span><wbr></wbr><span>Logging</span><wbr></wbr><span>Drop</span><wbr></wbr><span><span>Exceptions</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="955173513%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="subscribe-logging-drop-exceptions.html">T</a><span class="token operator">> </span><span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><span class="token operator"><</span><a href="subscribe-logging-drop-exceptions.html">T</a><span class="token operator">></span><span class="token punctuation">.</span><a href="subscribe-logging-drop-exceptions.html"><span class="token function">subscribeLoggingDropExceptions</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">scope<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">noinline </span>errorMessageBuilder<span class="token operator">: </span><a href="subscribe-logging-drop-exceptions.html">T</a><span class="token punctuation">.</span><span class="token punctuation">(</span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-throwable/index.html">Throwable</a><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html">Any</a><span class="token operator"> = </span>{ "Something web wrong" }<span class="token punctuation">, </span></span><span class="parameter ">logger<span class="token operator">: </span><span data-unresolved-link="dev.inmo.kslog.common/KSLog///PointingToDeclaration/">KSLog</span><span class="token operator"> = </span>KSLog<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">noinline </span>block<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><a href="subscribe-logging-drop-exceptions.html">T</a><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html">Unit</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span></div><div class="brief "><p class="paragraph">Use <span data-unresolved-link="dev.inmo.micro_utils.coroutines//subscribeSafelyWithoutExceptions/kotlinx.coroutines.flow.Flow[TypeParam(bounds=[kotlin.Any?])]#kotlinx.coroutines.CoroutineScope#kotlin.coroutines.SuspendFunction1[kotlin.Throwable,TypeParam(bounds=[kotlin.Any?])?]#kotlin.coroutines.SuspendFunction1[TypeParam(bounds=[kotlin.Any?]),kotlin.Unit]/PointingToDeclaration/">subscribeSafelyWithoutExceptions</span>, but all exceptions will be passed to <a href="default-safely-exception-handler.html">defaultSafelyExceptionHandler</a></p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-828974207%2FFunctions%2F-1457309097" anchor-label="subscribeLoggingDropExceptionsAsync" id="-828974207%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="subscribe-logging-drop-exceptions-async.html"><span>subscribe</span><wbr></wbr><span>Logging</span><wbr></wbr><span>Drop</span><wbr></wbr><span>Exceptions</span><wbr></wbr><span><span>Async</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-828974207%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">fun </span><span class="token operator"><</span><a href="subscribe-logging-drop-exceptions-async.html">T</a><span class="token punctuation">, </span><a href="subscribe-logging-drop-exceptions-async.html">M</a><span class="token operator">> </span><span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><span class="token operator"><</span><a href="subscribe-logging-drop-exceptions-async.html">T</a><span class="token operator">></span><span class="token punctuation">.</span><a href="subscribe-logging-drop-exceptions-async.html"><span class="token function">subscribeLoggingDropExceptionsAsync</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">scope<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">, </span></span><span class="parameter ">markerFactory<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><a href="subscribe-logging-drop-exceptions-async.html">T</a><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="subscribe-logging-drop-exceptions-async.html">M</a><span class="token punctuation">, </span></span><span class="parameter ">logger<span class="token operator">: </span><span data-unresolved-link="dev.inmo.kslog.common/KSLog///PointingToDeclaration/">KSLog</span><span class="token operator"> = </span>KSLog<span class="token punctuation">, </span></span><span class="parameter ">block<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><a href="subscribe-logging-drop-exceptions-async.html">T</a><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html">Unit</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span></div><div class="brief "><p class="paragraph">Subscribes to a <span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span> with asynchronous processing based on markers, automatically logging and dropping exceptions. Each value from the flow will be processed by the <a href="subscribe-logging-drop-exceptions-async.html">block</a> function. Values with the same marker will be processed sequentially, while values with different markers can be processed concurrently. Any exceptions thrown during processing will be logged and dropped without affecting other messages.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-937234808%2FFunctions%2F-1457309097" anchor-label="suspendPoint" id="-937234808%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="suspend-point.html"><span>suspend</span><wbr></wbr><span><span>Point</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-937234808%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="suspend-point.html"><span class="token function">suspendPoint</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Ensures that the current coroutine context is still active and throws a <span data-unresolved-link="kotlinx.coroutines/CancellationException///PointingToDeclaration/">kotlinx.coroutines.CancellationException</span> if the coroutine has been canceled.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="1118210483%2FFunctions%2F-1457309097" anchor-label="takeNotNull" id="1118210483%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="take-not-null.html"><span>take</span><wbr></wbr><span>Not</span><wbr></wbr><span><span>Null</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1118210483%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">fun </span><span class="token operator"><</span><a href="take-not-null.html">T</a><span class="token operator">> </span><span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><span class="token operator"><</span><a href="take-not-null.html">T</a><span class="token operator">></span><span class="token punctuation">.</span><a href="take-not-null.html"><span class="token function">takeNotNull</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><span class="token operator"><</span><a href="take-not-null.html">T</a><span class="token operator"> & </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html">Any</a><span class="token operator">></span></div><div class="brief "><p class="paragraph">Filters out null values from this <span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span>, returning only non-null elements.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-1685867955%2FFunctions%2F1069517945" anchor-label="toByteArray" id="-1685867955%2FFunctions%2F1069517945" data-filterable-set=":micro_utils.dokka/jsMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/jsMain" data-filterable-set=":micro_utils.dokka/jsMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="to-byte-array.html"><span>to</span><wbr></wbr><span>Byte</span><wbr></wbr><span><span>Array</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1685867955%2FFunctions%2F1069517945"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<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=":micro_utils.dokka/jsMain" data-filterable-set=":micro_utils.dokka/jsMain" data-active="" data-toggle=":micro_utils.dokka/jsMain">js</button></div>
|
|
<div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/jsMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><span data-unresolved-link="org.w3c.files/Blob///PointingToDeclaration/">Blob</span><span class="token punctuation">.</span><a href="to-byte-array.html"><span class="token function">toByteArray</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-byte-array/index.html">ByteArray</a></div></div> </div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="1277163199%2FFunctions%2F1069517945" anchor-label="visibilityFlow" id="1277163199%2FFunctions%2F1069517945" data-filterable-set=":micro_utils.dokka/jsMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/jsMain" data-filterable-set=":micro_utils.dokka/jsMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="visibility-flow.html"><span>visibility</span><wbr></wbr><span><span>Flow</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1277163199%2FFunctions%2F1069517945"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<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=":micro_utils.dokka/jsMain" data-filterable-set=":micro_utils.dokka/jsMain" data-active="" data-toggle=":micro_utils.dokka/jsMain">js</button></div>
|
|
<div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/jsMain"><div class="symbol monospace"><span class="token keyword">fun </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/org.w3c.dom/-element/index.html">Element</a><span class="token punctuation">.</span><a href="visibility-flow.html"><span class="token function">visibilityFlow</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines.flow/Flow///PointingToDeclaration/">Flow</span><span class="token operator"><</span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator">></span></div></div> </div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="1443039409%2FFunctions%2F-1457309097" anchor-label="waitReadRelease" id="1443039409%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="wait-read-release.html"><span>wait</span><wbr></wbr><span>Read</span><wbr></wbr><span><span>Release</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1443039409%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="-smart-r-w-locker/index.html">SmartRWLocker</a><span class="token punctuation">.</span><a href="wait-read-release.html"><span class="token function">waitReadRelease</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">permits<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html">Int</a><span class="token operator"> = </span><span class="token constant">1</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html">Int</a></div><div class="brief "><p class="paragraph">Will wait until the <a href="-smart-semaphore/permits-state-flow.html">SmartSemaphore.permitsStateFlow</a> of <a href="-smart-r-w-locker/index.html">this</a> instance will have <a href="wait-read-release.html">permits</a> count free permits.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="965013650%2FFunctions%2F-1457309097" anchor-label="waitRelease" id="965013650%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="wait-release.html"><span>wait</span><wbr></wbr><span><span>Release</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="965013650%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="-smart-semaphore/index.html">SmartSemaphore</a><span class="token punctuation">.</span><a href="wait-release.html"><span class="token function">waitRelease</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">permits<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html">Int</a><span class="token operator"> = </span><span class="token constant">1</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html">Int</a></div><div class="brief "><p class="paragraph">Will wait until the <a href="-smart-semaphore/permits-state-flow.html">SmartSemaphore.permitsStateFlow</a> of <a href="-smart-semaphore/index.html">this</a> instance will have <a href="wait-release.html">permits</a> count free permits.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="1821739093%2FFunctions%2F-1457309097" anchor-label="waitReleaseAll" id="1821739093%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="wait-release-all.html"><span>wait</span><wbr></wbr><span>Release</span><wbr></wbr><span><span>All</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1821739093%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="-smart-semaphore/index.html">SmartSemaphore</a><span class="token punctuation">.</span><a href="wait-release-all.html"><span class="token function">waitReleaseAll</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html">Int</a></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-2110023258%2FFunctions%2F-1457309097" anchor-label="waitUnlock" id="-2110023258%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="wait-unlock.html"><span>wait</span><wbr></wbr><span><span>Unlock</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-2110023258%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="-smart-mutex/index.html">SmartMutex</a><span class="token punctuation">.</span><a href="wait-unlock.html"><span class="token function">waitUnlock</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="brief "><p class="paragraph">Will wait until the <a href="-smart-mutex/lock-state-flow.html">SmartMutex.lockStateFlow</a> of <a href="-smart-mutex/index.html">this</a> instance will be false.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-1144357947%2FFunctions%2F-1457309097" anchor-label="waitWriteUnlock" id="-1144357947%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="wait-write-unlock.html"><span>wait</span><wbr></wbr><span>Write</span><wbr></wbr><span><span>Unlock</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1144357947%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="-smart-r-w-locker/index.html">SmartRWLocker</a><span class="token punctuation">.</span><a href="wait-write-unlock.html"><span class="token function">waitWriteUnlock</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="brief "><p class="paragraph">Will wait until the <a href="-smart-mutex/lock-state-flow.html">SmartMutex.lockStateFlow</a> of <a href="-smart-r-w-locker/index.html">this</a> instance will be false.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="667192353%2FFunctions%2F-1457309097" anchor-label="WeakScope" id="667192353%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="-weak-scope.html"><span>Weak</span><wbr></wbr><span><span>Scope</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="667192353%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">fun </span><a href="-weak-scope.html"><span class="token function">WeakScope</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">context<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.coroutines/-coroutine-context/index.html">CoroutineContext</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span></div><div class="brief "><p class="paragraph">Created <span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span> which will <span data-unresolved-link="kotlinx.coroutines//launch/kotlinx.coroutines.CoroutineScope#kotlin.coroutines.CoroutineContext#kotlinx.coroutines.CoroutineStart#kotlin.coroutines.SuspendFunction1[kotlinx.coroutines.CoroutineScope,kotlin.Unit]/PointingToDeclaration/">launch</span> listening of <a href="-weak-scope.html">context</a> job completing and drop itself. Current weak scope <strong>will not</strong> be attached to <a href="-weak-scope.html">context</a> directly. So, this <span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span> will not prevent parent one from cancelling if it is launched with <span data-unresolved-link="kotlinx.coroutines//supervisorScope/#kotlin.coroutines.SuspendFunction1[kotlinx.coroutines.CoroutineScope,TypeParam(bounds=[kotlin.Any?])]/PointingToDeclaration/">supervisorScope</span> or <span data-unresolved-link="kotlinx.coroutines//coroutineScope/#kotlin.coroutines.SuspendFunction1[kotlinx.coroutines.CoroutineScope,TypeParam(bounds=[kotlin.Any?])]/PointingToDeclaration/">coroutineScope</span>, but still will follow closing status of parent <span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span></p></div><div class="symbol monospace"><span class="token keyword">fun </span><a href="-weak-scope.html"><span class="token function">WeakScope</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">scope<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span></div><div class="brief "><p class="paragraph">Created <span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span> which will <span data-unresolved-link="kotlinx.coroutines//launch/kotlinx.coroutines.CoroutineScope#kotlin.coroutines.CoroutineContext#kotlinx.coroutines.CoroutineStart#kotlin.coroutines.SuspendFunction1[kotlinx.coroutines.CoroutineScope,kotlin.Unit]/PointingToDeclaration/">launch</span> listening of <a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.coroutines/-coroutine-context/index.html">scope</a> job completing and drop itself. Current weak scope <strong>will not</strong> be attached to <a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.coroutines/-coroutine-context/index.html">scope</a> directly. So, this <span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span> will not prevent parent one from cancelling if it is launched with <span data-unresolved-link="kotlinx.coroutines//supervisorScope/#kotlin.coroutines.SuspendFunction1[kotlinx.coroutines.CoroutineScope,TypeParam(bounds=[kotlin.Any?])]/PointingToDeclaration/">supervisorScope</span> or <span data-unresolved-link="kotlinx.coroutines//coroutineScope/#kotlin.coroutines.SuspendFunction1[kotlinx.coroutines.CoroutineScope,TypeParam(bounds=[kotlin.Any?])]/PointingToDeclaration/">coroutineScope</span>, but still will follow closing status of parent <span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span></p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-1233740026%2FFunctions%2F-1457309097" anchor-label="withAcquire" id="-1233740026%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="with-acquire.html"><span>with</span><wbr></wbr><span><span>Acquire</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1233740026%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">inline suspend </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="with-acquire.html">T</a><span class="token operator">> </span><a href="-smart-semaphore/-mutable/index.html">SmartSemaphore.Mutable</a><span class="token punctuation">.</span><a href="with-acquire.html"><span class="token function">withAcquire</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">permits<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html">Int</a><span class="token operator"> = </span><span class="token constant">1</span><span class="token punctuation">, </span></span><span class="parameter ">action<span class="token operator">: </span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="with-acquire.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="with-acquire.html">T</a></div><div class="brief "><p class="paragraph">Will call SmartSemaphore.Mutable.lock, then execute <a href="with-acquire.html">action</a> and return the result after SmartSemaphore.Mutable.unlock</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-1246915885%2FFunctions%2F-1457309097" anchor-label="withLock" id="-1246915885%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="with-lock.html"><span>with</span><wbr></wbr><span><span>Lock</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1246915885%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">inline suspend </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="with-lock.html">T</a><span class="token operator">> </span><a href="-smart-mutex/-mutable/index.html">SmartMutex.Mutable</a><span class="token punctuation">.</span><a href="with-lock.html"><span class="token function">withLock</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">action<span class="token operator">: </span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="with-lock.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="with-lock.html">T</a></div><div class="brief "><p class="paragraph">Will call <a href="-smart-mutex/-mutable/lock.html">SmartMutex.Mutable.lock</a>, then execute <a href="with-lock.html">action</a> and return the result after <a href="-smart-mutex/-mutable/unlock.html">SmartMutex.Mutable.unlock</a></p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="885611399%2FFunctions%2F-1457309097" anchor-label="withReadAcquire" id="885611399%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="with-read-acquire.html"><span>with</span><wbr></wbr><span>Read</span><wbr></wbr><span><span>Acquire</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="885611399%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">inline suspend </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="with-read-acquire.html">T</a><span class="token punctuation">, </span><a href="with-read-acquire.html">R</a><span class="token operator">> </span><a href="-smart-key-r-w-locker/index.html">SmartKeyRWLocker</a><span class="token operator"><</span><a href="with-read-acquire.html">T</a><span class="token operator">></span><span class="token punctuation">.</span><a href="with-read-acquire.html"><span class="token function">withReadAcquire</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">action<span class="token operator">: </span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="with-read-acquire.html">R</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="with-read-acquire.html">R</a></div><div class="symbol monospace"><span class="token keyword">inline suspend </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="with-read-acquire.html">T</a><span class="token punctuation">, </span><a href="with-read-acquire.html">R</a><span class="token operator">> </span><a href="-smart-key-r-w-locker/index.html">SmartKeyRWLocker</a><span class="token operator"><</span><a href="with-read-acquire.html">T</a><span class="token operator">></span><span class="token punctuation">.</span><a href="with-read-acquire.html"><span class="token function">withReadAcquire</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">key<span class="token operator">: </span><a href="with-read-acquire.html">T</a><span class="token punctuation">, </span></span><span class="parameter ">action<span class="token operator">: </span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="with-read-acquire.html">R</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="with-read-acquire.html">R</a></div><br><div class="symbol monospace"><span class="token keyword">inline suspend </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="with-read-acquire.html">T</a><span class="token operator">> </span><a href="-smart-r-w-locker/index.html">SmartRWLocker</a><span class="token punctuation">.</span><a href="with-read-acquire.html"><span class="token function">withReadAcquire</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">action<span class="token operator">: </span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="with-read-acquire.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="with-read-acquire.html">T</a></div><div class="brief "><p class="paragraph">Will call SmartSemaphore.Mutable.lock, then execute <a href="with-read-acquire.html">action</a> and return the result after SmartSemaphore.Mutable.unlock</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-1837801328%2FFunctions%2F-1457309097" anchor-label="withReadAcquires" id="-1837801328%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="with-read-acquires.html"><span>with</span><wbr></wbr><span>Read</span><wbr></wbr><span><span>Acquires</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1837801328%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">inline suspend </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="with-read-acquires.html">T</a><span class="token punctuation">, </span><a href="with-read-acquires.html">R</a><span class="token operator">> </span><a href="-smart-key-r-w-locker/index.html">SmartKeyRWLocker</a><span class="token operator"><</span><a href="with-read-acquires.html">T</a><span class="token operator">></span><span class="token punctuation">.</span><a href="with-read-acquires.html"><span class="token function">withReadAcquires</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">keys<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-iterable/index.html">Iterable</a><span class="token operator"><</span><a href="with-read-acquires.html">T</a><span class="token operator">></span><span class="token punctuation">, </span></span><span class="parameter ">action<span class="token operator">: </span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="with-read-acquires.html">R</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="with-read-acquires.html">R</a></div><div class="symbol monospace"><span class="token keyword">inline suspend </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="with-read-acquires.html">T</a><span class="token punctuation">, </span><a href="with-read-acquires.html">R</a><span class="token operator">> </span><a href="-smart-key-r-w-locker/index.html">SmartKeyRWLocker</a><span class="token operator"><</span><a href="with-read-acquires.html">T</a><span class="token operator">></span><span class="token punctuation">.</span><a href="with-read-acquires.html"><span class="token function">withReadAcquires</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">vararg </span>keys<span class="token operator">: </span><a href="with-read-acquires.html">T</a><span class="token punctuation">, </span></span><span class="parameter ">action<span class="token operator">: </span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="with-read-acquires.html">R</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="with-read-acquires.html">R</a></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-1270953923%2FFunctions%2F-1457309097" anchor-label="withWriteLock" id="-1270953923%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="with-write-lock.html"><span>with</span><wbr></wbr><span>Write</span><wbr></wbr><span><span>Lock</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1270953923%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">inline suspend </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="with-write-lock.html">T</a><span class="token punctuation">, </span><a href="with-write-lock.html">R</a><span class="token operator">> </span><a href="-smart-key-r-w-locker/index.html">SmartKeyRWLocker</a><span class="token operator"><</span><a href="with-write-lock.html">T</a><span class="token operator">></span><span class="token punctuation">.</span><a href="with-write-lock.html"><span class="token function">withWriteLock</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">action<span class="token operator">: </span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="with-write-lock.html">R</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="with-write-lock.html">R</a></div><div class="symbol monospace"><span class="token keyword">inline suspend </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="with-write-lock.html">T</a><span class="token punctuation">, </span><a href="with-write-lock.html">R</a><span class="token operator">> </span><a href="-smart-key-r-w-locker/index.html">SmartKeyRWLocker</a><span class="token operator"><</span><a href="with-write-lock.html">T</a><span class="token operator">></span><span class="token punctuation">.</span><a href="with-write-lock.html"><span class="token function">withWriteLock</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">key<span class="token operator">: </span><a href="with-write-lock.html">T</a><span class="token punctuation">, </span></span><span class="parameter ">action<span class="token operator">: </span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="with-write-lock.html">R</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="with-write-lock.html">R</a></div><br><div class="symbol monospace"><span class="token keyword">inline suspend </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="with-write-lock.html">T</a><span class="token operator">> </span><a href="-smart-r-w-locker/index.html">SmartRWLocker</a><span class="token punctuation">.</span><a href="with-write-lock.html"><span class="token function">withWriteLock</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">action<span class="token operator">: </span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="with-write-lock.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="with-write-lock.html">T</a></div><div class="brief "><p class="paragraph">Will call <a href="-smart-mutex/-mutable/lock.html">SmartMutex.Mutable.lock</a>, then execute <a href="with-write-lock.html">action</a> and return the result after <a href="-smart-mutex/-mutable/unlock.html">SmartMutex.Mutable.unlock</a></p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="1380018064%2FFunctions%2F-1457309097" anchor-label="withWriteLocks" id="1380018064%2FFunctions%2F-1457309097" data-filterable-set=":micro_utils.dokka/commonMain"></a>
|
|
<div class="table-row table-row_content" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka/commonMain" data-filterable-set=":micro_utils.dokka/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="with-write-locks.html"><span>with</span><wbr></wbr><span>Write</span><wbr></wbr><span><span>Locks</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1380018064%2FFunctions%2F-1457309097"></span>
|
|
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
|
</span></span></div>
|
|
<div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka/commonMain"><div class="symbol monospace"><span class="token keyword">inline suspend </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="with-write-locks.html">T</a><span class="token punctuation">, </span><a href="with-write-locks.html">R</a><span class="token operator">> </span><a href="-smart-key-r-w-locker/index.html">SmartKeyRWLocker</a><span class="token operator"><</span><a href="with-write-locks.html">T</a><span class="token operator">></span><span class="token punctuation">.</span><a href="with-write-locks.html"><span class="token function">withWriteLocks</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">keys<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-iterable/index.html">Iterable</a><span class="token operator"><</span><a href="with-write-locks.html">T</a><span class="token operator">></span><span class="token punctuation">, </span></span><span class="parameter ">action<span class="token operator">: </span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="with-write-locks.html">R</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="with-write-locks.html">R</a></div><div class="symbol monospace"><span class="token keyword">inline suspend </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="with-write-locks.html">T</a><span class="token punctuation">, </span><a href="with-write-locks.html">R</a><span class="token operator">> </span><a href="-smart-key-r-w-locker/index.html">SmartKeyRWLocker</a><span class="token operator"><</span><a href="with-write-locks.html">T</a><span class="token operator">></span><span class="token punctuation">.</span><a href="with-write-locks.html"><span class="token function">withWriteLocks</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">vararg </span>keys<span class="token operator">: </span><a href="with-write-locks.html">T</a><span class="token punctuation">, </span></span><span class="parameter ">action<span class="token operator">: </span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="with-write-locks.html">R</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="with-write-locks.html">R</a></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="footer">
|
|
<div class="footer--container">
|
|
<a href="#content" id="go-to-top-link" class="footer--button footer--button_go-to-top"></a>
|
|
<div class="footer--content">
|
|
<div>
|
|
<span>Generated by </span>
|
|
<a class="footer--link footer--link_external" href="https://github.com/Kotlin/dokka">
|
|
Dokka
|
|
</a>
|
|
<div>© 2026 Copyright</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html> |