mirror of
https://github.com/InsanusMokrassar/MicroUtils.git
synced 2025-10-16 21:00:31 +00:00
deploy: ea497ea488
This commit is contained in:
InsanusMokrassar
@@ -65,7 +65,7 @@
|
||||
<div class="breadcrumbs"><a href="../../../index.html">micro_utils.dokka</a><span class="delimiter">/</span><a href="../index.html">dev.inmo.micro_utils.fsm.common</a><span class="delimiter">/</span><span class="current">UpdatableStatesMachine</span></div>
|
||||
<div class="cover ">
|
||||
<h1 class="cover"><span>Updatable</span><wbr></wbr><span>States</span><wbr></wbr><span><span>Machine</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:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">interface </span><a href="index.html">UpdatableStatesMachine</a><span class="token operator"><</span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator"> : </span><a href="../-state/index.html">State</a><span class="token operator">></span> : <a href="../-states-machine/index.html">StatesMachine</a><span class="token operator"><</span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator">> </span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//fsm/common/src/commonMain/kotlin/dev/inmo/micro_utils/fsm/common/UpdatableStatesMachine.kt#L13">source</a>)</span></span></div><p class="paragraph">This extender of <a href="../-states-machine/index.html">StatesMachine</a> interface declare one new function <a href="update-chain.html">updateChain</a>. Realizations of this interface must be able to perform update of chain in internal <a href="../-states-manager/index.html">StatesManager</a></p><h4 class="">Inheritors</h4><div class="table"><div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-default-updatable-states-machine/index.html">DefaultUpdatableStatesMachine</a></div></span></div><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:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">interface </span><a href="index.html">UpdatableStatesMachine</a><span class="token operator"><</span><a href="index.html">T</a><span class="token operator"> : </span><a href="../-state/index.html">State</a><span class="token operator">></span> : <a href="../-states-machine/index.html">StatesMachine</a><span class="token operator"><</span><a href="index.html">T</a><span class="token operator">> </span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//fsm/common/src/commonMain/kotlin/dev/inmo/micro_utils/fsm/common/UpdatableStatesMachine.kt#L13">source</a>)</span></span></div><p class="paragraph">This extender of <a href="../-states-machine/index.html">StatesMachine</a> interface declare one new function <a href="update-chain.html">updateChain</a>. Realizations of this interface must be able to perform update of chain in internal <a href="../-states-manager/index.html">StatesManager</a></p><h4 class="">Inheritors</h4><div class="table"><div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-default-updatable-states-machine/index.html">DefaultUpdatableStatesMachine</a></div></span></div><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>
|
||||
@@ -73,7 +73,7 @@
|
||||
<div data-togglable="FUNCTION">
|
||||
<h2 class="">Functions</h2>
|
||||
<div class="table"><a data-name="1210167093%2FFunctions%2F-1478683138" anchor-label="handleState" id="1210167093%2FFunctions%2F-1478683138" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"></a>
|
||||
<div class="table-row" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain">
|
||||
<div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain">
|
||||
<div class="main-subrow keyValue ">
|
||||
<div class=""><span class="inline-flex">
|
||||
<div><a href="../-states-handler/handle-state.html"><span>handle</span><wbr></wbr><span><span>State</span></span></a></div>
|
||||
@@ -97,7 +97,7 @@
|
||||
</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:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><span class="token operator"><</span><span class="token keyword"></span><a href="../holder.html">I</a><span class="token operator"> : </span><a href="../holder.html">O</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../holder.html">O</a><span class="token operator"> : </span><a href="../-state/index.html">State</a><span class="token operator">> </span><a href="../-states-handler/index.html">StatesHandler</a><span class="token operator"><</span><span class="token keyword"></span><a href="../holder.html">I</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../holder.html">O</a><span class="token operator">></span><span class="token punctuation">.</span><a href="../holder.html"><span class="token function">holder</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">strict<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/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="../-customizable-handler-holder/index.html">CustomizableHandlerHolder</a><span class="token operator"><</span><span class="token keyword"></span><a href="../holder.html">O</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../holder.html">O</a><span class="token operator">></span></div><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><span class="token operator"><</span><span class="token keyword"></span><a href="../holder.html">I</a><span class="token operator"> : </span><a href="../holder.html">O</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../holder.html">O</a><span class="token operator"> : </span><a href="../-state/index.html">State</a><span class="token operator">> </span><a href="../-states-handler/index.html">StatesHandler</a><span class="token operator"><</span><span class="token keyword"></span><a href="../holder.html">I</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../holder.html">O</a><span class="token operator">></span><span class="token punctuation">.</span><a href="../holder.html"><span class="token function">holder</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">noinline </span>filter<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><span class="token keyword"></span>state<span class="token operator">: </span><a href="../-state/index.html">State</a><span class="token punctuation">)</span><span class="token operator"> -> </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../-customizable-handler-holder/index.html">CustomizableHandlerHolder</a><span class="token operator"><</span><span class="token keyword"></span><a href="../holder.html">O</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../holder.html">O</a><span class="token operator">></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:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="../holder.html">I</a><span class="token operator"> : </span><a href="../holder.html">O</a><span class="token punctuation">, </span><a href="../holder.html">O</a><span class="token operator"> : </span><a href="../-state/index.html">State</a><span class="token operator">> </span><a href="../-states-handler/index.html">StatesHandler</a><span class="token operator"><</span><a href="../holder.html">I</a><span class="token punctuation">, </span><a href="../holder.html">O</a><span class="token operator">></span><span class="token punctuation">.</span><a href="../holder.html"><span class="token function">holder</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">strict<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/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="../-customizable-handler-holder/index.html">CustomizableHandlerHolder</a><span class="token operator"><</span><a href="../holder.html">O</a><span class="token punctuation">, </span><a href="../holder.html">O</a><span class="token operator">></span></div><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><span class="token operator"><</span><a href="../holder.html">I</a><span class="token operator"> : </span><a href="../holder.html">O</a><span class="token punctuation">, </span><a href="../holder.html">O</a><span class="token operator"> : </span><a href="../-state/index.html">State</a><span class="token operator">> </span><a href="../-states-handler/index.html">StatesHandler</a><span class="token operator"><</span><a href="../holder.html">I</a><span class="token punctuation">, </span><a href="../holder.html">O</a><span class="token operator">></span><span class="token punctuation">.</span><a href="../holder.html"><span class="token function">holder</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">noinline </span>filter<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span>state<span class="token operator">: </span><a href="../-state/index.html">State</a><span class="token punctuation">)</span><span class="token operator"> -> </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../-customizable-handler-holder/index.html">CustomizableHandlerHolder</a><span class="token operator"><</span><a href="../holder.html">O</a><span class="token punctuation">, </span><a href="../holder.html">O</a><span class="token operator">></span></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
@@ -112,7 +112,7 @@
|
||||
</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:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="../-states-machine/launch-state-handling.html"><span class="token function">launchStateHandling</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">state<span class="token operator">: </span><a href="index.html">T</a><span class="token punctuation">, </span></span><span class="parameter ">handlers<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator"><</span><span class="token keyword"></span><a href="../-checkable-handler-holder/index.html">CheckableHandlerHolder</a><span class="token operator"><</span><span class="token keyword">in </span><a href="index.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator">></span><span class="token operator">></span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">T</a><span class="token operator">?</span></div><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="../-states-machine/launch-state-handling.html"><span class="token function">launchStateHandling</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">state<span class="token operator">: </span><a href="index.html">T</a><span class="token punctuation">, </span></span><span class="parameter ">handlers<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator"><</span><span class="token keyword"></span><a href="../-checkable-handler-holder/index.html">CheckableHandlerHolder</a><span class="token operator"><</span><span class="token keyword">in </span><a href="index.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator">></span><span class="token operator">></span><span class="token punctuation">, </span></span><span class="parameter ">onStateHandlingErrorHandler<span class="token operator">: </span><a href="../../dev.inmo.micro_utils.fsm.common.utils/-state-handling-error-handler/index.html">StateHandlingErrorHandler</a><span class="token operator"><</span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator">></span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">T</a><span class="token operator">?</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:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="../-states-machine/launch-state-handling.html"><span class="token function">launchStateHandling</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">state<span class="token operator">: </span><a href="index.html">T</a><span class="token punctuation">, </span></span><span class="parameter ">handlers<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator"><</span><a href="../-checkable-handler-holder/index.html">CheckableHandlerHolder</a><span class="token operator"><</span><span class="token keyword">in </span><a href="index.html">T</a><span class="token punctuation">, </span><a href="index.html">T</a><span class="token operator">></span><span class="token operator">></span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">T</a><span class="token operator">?</span></div><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="../-states-machine/launch-state-handling.html"><span class="token function">launchStateHandling</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">state<span class="token operator">: </span><a href="index.html">T</a><span class="token punctuation">, </span></span><span class="parameter ">handlers<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator"><</span><a href="../-checkable-handler-holder/index.html">CheckableHandlerHolder</a><span class="token operator"><</span><span class="token keyword">in </span><a href="index.html">T</a><span class="token punctuation">, </span><a href="index.html">T</a><span class="token operator">></span><span class="token operator">></span><span class="token punctuation">, </span></span><span class="parameter ">onStateHandlingErrorHandler<span class="token operator">: </span><a href="../../dev.inmo.micro_utils.fsm.common.utils/-state-handling-error-handler/index.html">StateHandlingErrorHandler</a><span class="token operator"><</span><a href="index.html">T</a><span class="token operator">></span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">T</a><span class="token operator">?</span></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
@@ -127,7 +127,7 @@
|
||||
</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:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="../-states-machine/start.html"><span class="token function">start</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/Job///PointingToDeclaration/">Job</span></div><div class="brief "><p class="paragraph">Starts handling of <a href="../-state/index.html">State</a>s</p></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:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword">fun </span><a href="../-states-machine/start.html"><span class="token function">start</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/Job///PointingToDeclaration/">Job</span></div><div class="brief "><p class="paragraph">Starts handling of <a href="../-state/index.html">State</a>s</p></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user