mirror of
https://github.com/InsanusMokrassar/MicroUtils.git
synced 2026-11-03 02:23:22 +00:00
deploy: c4f15c32ea
This commit is contained in:
InsanusMokrassar committed
1 parent
86d5770b36
commit
26bd39cf2e
6589 files changed
+6636
-6636
No files matched your search
+2
-2
@@ -43,7 +43,7 @@
|
||||
</button>
|
||||
<div class="navigation-controls--break ui-kit_mobile-only"></div>
|
||||
<div class="library-version" id="library-version">
|
||||
0.31.0 </div>
|
||||
0.31.1 </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 common-like" data-active="" aria-pressed="true"
|
||||
@@ -108,7 +108,7 @@
|
||||
<div class="cover ">
|
||||
<h1 class="cover"><span><span>Mutable</span></span></h1>
|
||||
</div>
|
||||
<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">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">locked<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><span class="source-link-wrapper"><span class="source-link" data-element-type="source-link">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//coroutines/src/commonMain/kotlin/dev/inmo/micro_utils/coroutines/SmartMutex.kt#L45">source</a>)</span></span></div><h4 class="tableheader">Parameters</h4><div class="table"><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><u><span><span>locked</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Preset state of <a href="../is-locked.html">isLocked</a> and its internal <span data-unresolved-link="dev.inmo.micro_utils.coroutines/SmartMutex.Mutable/_lockStateFlow/#/PointingToDeclaration/">_lockStateFlow</span></p></div></div></div></div></div></div></div>
|
||||
<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">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">locked<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><span class="source-link-wrapper"><span class="source-link" data-element-type="source-link">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//coroutines/src/commonMain/kotlin/dev/inmo/micro_utils/coroutines/SmartMutex.kt#L47">source</a>)</span></span></div><h4 class="tableheader">Parameters</h4><div class="table"><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><u><span><span>locked</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Preset state of <a href="../is-locked.html">isLocked</a> and its internal <span data-unresolved-link="dev.inmo.micro_utils.coroutines/SmartMutex.Mutable/_lockStateFlow/#/PointingToDeclaration/">_lockStateFlow</span></p></div></div></div></div></div></div></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
<div class="footer--container">
|
||||
|
||||
+2
-2
@@ -43,7 +43,7 @@
|
||||
</button>
|
||||
<div class="navigation-controls--break ui-kit_mobile-only"></div>
|
||||
<div class="library-version" id="library-version">
|
||||
0.31.0 </div>
|
||||
0.31.1 </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 common-like" data-active="" aria-pressed="true"
|
||||
@@ -108,7 +108,7 @@
|
||||
<div class="cover ">
|
||||
<h1 class="cover"><span><span>immutable</span></span></h1>
|
||||
</div>
|
||||
<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="immutable.html"><span class="token function">immutable</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../-immutable/index.html">SmartMutex.Immutable</a><span class="source-link-wrapper"><span class="source-link" data-element-type="source-link">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//coroutines/src/commonMain/kotlin/dev/inmo/micro_utils/coroutines/SmartMutex.kt#L51">source</a>)</span></span></div></div></div>
|
||||
<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="immutable.html"><span class="token function">immutable</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../-immutable/index.html">SmartMutex.Immutable</a><span class="source-link-wrapper"><span class="source-link" data-element-type="source-link">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//coroutines/src/commonMain/kotlin/dev/inmo/micro_utils/coroutines/SmartMutex.kt#L53">source</a>)</span></span></div></div></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
<div class="footer--container">
|
||||
|
||||
@@ -43,7 +43,7 @@
|
||||
</button>
|
||||
<div class="navigation-controls--break ui-kit_mobile-only"></div>
|
||||
<div class="library-version" id="library-version">
|
||||
0.31.0 </div>
|
||||
0.31.1 </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 common-like" data-active="" aria-pressed="true"
|
||||
@@ -107,7 +107,7 @@
|
||||
<div class="breadcrumbs"><a href="../../../../index.html">micro_utils.dokka</a><span class="delimiter">/</span><a href="../../index.html">dev.inmo.micro_utils.coroutines</a><span class="delimiter">/</span><a href="../index.html">SmartMutex</a><span class="delimiter">/</span><span class="current">Mutable</span></div>
|
||||
<div class="cover ">
|
||||
<h1 class="cover"><span><span>Mutable</span></span></h1>
|
||||
<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="index.html">Mutable</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">locked<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> : <a href="../index.html">SmartMutex</a><span class="source-link-wrapper"><span class="source-link" data-element-type="source-link">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//coroutines/src/commonMain/kotlin/dev/inmo/micro_utils/coroutines/SmartMutex.kt#L45">source</a>)</span></span></div><p class="paragraph">Mutable variant of <a href="../index.html">SmartMutex</a>. With that variant you may <a href="lock.html">lock</a> and <a href="unlock.html">unlock</a>. Besides, you may create <a href="../-immutable/index.html">Immutable</a> variant of this instance with <a href="immutable.html">immutable</a> factory</p><h4 class="tableheader">Parameters</h4><div class="table"><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><u><span><span>locked</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Preset state of <a href="../is-locked.html">isLocked</a> and its internal <span data-unresolved-link="dev.inmo.micro_utils.coroutines/SmartMutex.Mutable/_lockStateFlow/#/PointingToDeclaration/">_lockStateFlow</span></p></div></div></div></div></div></div></div>
|
||||
<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="index.html">Mutable</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">locked<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> : <a href="../index.html">SmartMutex</a><span class="source-link-wrapper"><span class="source-link" data-element-type="source-link">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//coroutines/src/commonMain/kotlin/dev/inmo/micro_utils/coroutines/SmartMutex.kt#L47">source</a>)</span></span></div><p class="paragraph">Mutable variant of <a href="../index.html">SmartMutex</a>. With that variant you may <a href="lock.html">lock</a> and <a href="unlock.html">unlock</a>. Besides, you may create <a href="../-immutable/index.html">Immutable</a> variant of this instance with <a href="immutable.html">immutable</a> factory</p><h4 class="tableheader">Parameters</h4><div class="table"><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><u><span><span>locked</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Preset state of <a href="../is-locked.html">isLocked</a> and its internal <span data-unresolved-link="dev.inmo.micro_utils.coroutines/SmartMutex.Mutable/_lockStateFlow/#/PointingToDeclaration/">_lockStateFlow</span></p></div></div></div></div></div></div></div>
|
||||
</div>
|
||||
<div class="tabbedcontent">
|
||||
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button><button class="section-tab" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION,EXTENSION_PROPERTY,EXTENSION_FUNCTION">Members & Extensions</button></div>
|
||||
|
||||
+2
-2
@@ -43,7 +43,7 @@
|
||||
</button>
|
||||
<div class="navigation-controls--break ui-kit_mobile-only"></div>
|
||||
<div class="library-version" id="library-version">
|
||||
0.31.0 </div>
|
||||
0.31.1 </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 common-like" data-active="" aria-pressed="true"
|
||||
@@ -108,7 +108,7 @@
|
||||
<div class="cover ">
|
||||
<h1 class="cover"><span>lock</span><wbr></wbr><span>State</span><wbr></wbr><span><span>Flow</span></span></h1>
|
||||
</div>
|
||||
<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">override </span><span class="token keyword">val </span><a href="lock-state-flow.html">lockStateFlow</a><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines.flow/StateFlow///PointingToDeclaration/">StateFlow</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><span class="source-link-wrapper"><span class="source-link" data-element-type="source-link">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//coroutines/src/commonMain/kotlin/dev/inmo/micro_utils/coroutines/SmartMutex.kt#L47">source</a>)</span></span></div></div></div>
|
||||
<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">override </span><span class="token keyword">val </span><a href="lock-state-flow.html">lockStateFlow</a><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines.flow/StateFlow///PointingToDeclaration/">StateFlow</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><span class="source-link-wrapper"><span class="source-link" data-element-type="source-link">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//coroutines/src/commonMain/kotlin/dev/inmo/micro_utils/coroutines/SmartMutex.kt#L49">source</a>)</span></span></div></div></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
<div class="footer--container">
|
||||
|
||||
@@ -43,7 +43,7 @@
|
||||
</button>
|
||||
<div class="navigation-controls--break ui-kit_mobile-only"></div>
|
||||
<div class="library-version" id="library-version">
|
||||
0.31.0 </div>
|
||||
0.31.1 </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 common-like" data-active="" aria-pressed="true"
|
||||
@@ -108,7 +108,7 @@
|
||||
<div class="cover ">
|
||||
<h1 class="cover"><span><span>lock</span></span></h1>
|
||||
</div>
|
||||
<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="lock.html"><span class="token function">lock</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="source-link-wrapper"><span class="source-link" data-element-type="source-link">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//coroutines/src/commonMain/kotlin/dev/inmo/micro_utils/coroutines/SmartMutex.kt#L57">source</a>)</span></span></div><p class="paragraph">Holds call until this <a href="../index.html">SmartMutex</a> will be re-locked. That means that while <a href="../is-locked.html">isLocked</a> == true, holds will wait for <a href="../is-locked.html">isLocked</a> == false and then try to lock</p></div></div>
|
||||
<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="lock.html"><span class="token function">lock</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="source-link-wrapper"><span class="source-link" data-element-type="source-link">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//coroutines/src/commonMain/kotlin/dev/inmo/micro_utils/coroutines/SmartMutex.kt#L59">source</a>)</span></span></div><p class="paragraph">Holds call until this <a href="../index.html">SmartMutex</a> will be re-locked. That means that while <a href="../is-locked.html">isLocked</a> == true, holds will wait for <a href="../is-locked.html">isLocked</a> == false and then try to lock</p></div></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
<div class="footer--container">
|
||||
|
||||
+2
-2
@@ -43,7 +43,7 @@
|
||||
</button>
|
||||
<div class="navigation-controls--break ui-kit_mobile-only"></div>
|
||||
<div class="library-version" id="library-version">
|
||||
0.31.0 </div>
|
||||
0.31.1 </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 common-like" data-active="" aria-pressed="true"
|
||||
@@ -108,7 +108,7 @@
|
||||
<div class="cover ">
|
||||
<h1 class="cover"><span>try</span><wbr></wbr><span><span>Lock</span></span></h1>
|
||||
</div>
|
||||
<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="try-lock.html"><span class="token function">tryLock</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><span class="source-link-wrapper"><span class="source-link" data-element-type="source-link">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//coroutines/src/commonMain/kotlin/dev/inmo/micro_utils/coroutines/SmartMutex.kt#L76">source</a>)</span></span></div><p class="paragraph">Will try to lock this <a href="../index.html">SmartMutex</a> immediataly</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">True if lock was successful. False otherwise</p></span></div></div>
|
||||
<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="try-lock.html"><span class="token function">tryLock</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><span class="source-link-wrapper"><span class="source-link" data-element-type="source-link">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//coroutines/src/commonMain/kotlin/dev/inmo/micro_utils/coroutines/SmartMutex.kt#L78">source</a>)</span></span></div><p class="paragraph">Will try to lock this <a href="../index.html">SmartMutex</a> immediataly</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">True if lock was successful. False otherwise</p></span></div></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
<div class="footer--container">
|
||||
|
||||
@@ -43,7 +43,7 @@
|
||||
</button>
|
||||
<div class="navigation-controls--break ui-kit_mobile-only"></div>
|
||||
<div class="library-version" id="library-version">
|
||||
0.31.0 </div>
|
||||
0.31.1 </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 common-like" data-active="" aria-pressed="true"
|
||||
@@ -108,7 +108,7 @@
|
||||
<div class="cover ">
|
||||
<h1 class="cover"><span><span>unlock</span></span></h1>
|
||||
</div>
|
||||
<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="unlock.html"><span class="token function">unlock</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><span class="source-link-wrapper"><span class="source-link" data-element-type="source-link">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//coroutines/src/commonMain/kotlin/dev/inmo/micro_utils/coroutines/SmartMutex.kt#L95">source</a>)</span></span></div><p class="paragraph">If <a href="../is-locked.html">isLocked</a> == true - will change it to false and return true. If current call will not unlock this <a href="../index.html">SmartMutex</a> - false</p></div></div>
|
||||
<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="unlock.html"><span class="token function">unlock</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><span class="source-link-wrapper"><span class="source-link" data-element-type="source-link">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//coroutines/src/commonMain/kotlin/dev/inmo/micro_utils/coroutines/SmartMutex.kt#L97">source</a>)</span></span></div><p class="paragraph">If <a href="../is-locked.html">isLocked</a> == true - will change it to false and return true. If current call will not unlock this <a href="../index.html">SmartMutex</a> - false</p></div></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
<div class="footer--container">
|
||||
|
||||
Reference in new issue
Block a user