InsanusMokrassar/MicroUtils
1
0
Fork 0
mirror of https://github.com/InsanusMokrassar/MicroUtils.git synced 2024-11-24 02:58:45 +00:00
Code Issues Packages Projects Releases Wiki Activity
a007628124
MicroUtils/micro_utils.dokka/dev.inmo.micro_utils.fsm.common/[common]-states-handler/index.html
InsanusMokrassar a007628124 deploy: 96ab2e8aca
2022-01-18 13:02:16 +00:00

109 lines
25 KiB
HTML
Raw Blame History

<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>[common]StatesHandler</title>
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg"><script>var pathToRoot = "../../../";</script> <script>const storage = localStorage.getItem("dokka-dark-mode")
const savedDarkMode = storage ? JSON.parse(storage) : false
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/jetbrains-mono.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"><script type="text/javascript" src="../../../scripts/clipboard.js" async="async"></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> </head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name"><a href="../../../index.html">micro_utils.dokka</a></div>
<div>0.9.4</div>
<div class="pull-right d-flex">
<div class="filter-section" id="filter-section"><button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":micro_utils.dokka:dokkaHtml/androidMain">android</button><button class="platform-tag platform-selector common-like" data-active="" data-filter=":micro_utils.dokka:dokkaHtml/commonMain">common</button><button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":micro_utils.dokka:dokkaHtml/jvmMain">jvm</button></div>
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></div>
</div>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" id="content" pageIds="micro_utils.dokka::dev.inmo.micro_utils.fsm.common/StatesHandler///PointingToDeclaration//-1478683138">
<div class="breadcrumbs"><a href="../../../index.html">micro_utils.dokka</a>/<a href="../index.html">dev.inmo.micro_utils.fsm.common</a>/<a href="index.html">[common]StatesHandler</a></div>
<div class="cover ">
<h1 class="cover"><span>States</span><wbr></wbr><span><span>Handler</span></span></h1>
<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 common-like" data-filterable-current=":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain" data-active="" data-toggle=":micro_utils.dokka:dokkaHtml/commonMain">common</button></div>
<div class="content sourceset-depenent-content" data-active="" data-togglable=":micro_utils.dokka:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">fun </span><span class="token keyword">interface </span><a href="index.html">StatesHandler</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">I</a><span class="token operator"> : </span><a href="../[common]-state/index.html">State</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="index.html">O</a><span class="token operator"> : </span><a href="../[common]-state/index.html">State</a><span class="token operator">&gt;</span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><p class="paragraph">Default realization of states handler</p></div> </div>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="Functions">Functions</button><button class="section-tab" data-togglable="Extensions">Extensions</button><button class="section-tab" data-togglable="Inheritors">Inheritors</button></div>
<div class="tabs-section-body">
<h2 class="">Functions</h2>
<div class="table" data-togglable="Functions"><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-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="handle-state.html"><span>handle</span><wbr></wbr><span><span>State</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1210167093%2FFunctions%2F-1478683138"></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 common-like" data-filterable-current=":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain" data-active="" data-toggle=":micro_utils.dokka:dokkaHtml/commonMain">common</button></div>
<div class="content sourceset-depenent-content" data-active="" data-togglable=":micro_utils.dokka:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="../[common]-states-machine/index.html">StatesMachine</a><span class="token operator">&lt;</span><span class="token keyword">in </span><a href="index.html">O</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="handle-state.html"><span class="token function">handleState</span></a><span class="token punctuation">(</span>state<span class="token operator">: </span><a href="index.html">I</a><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">O</a><span class="token operator">?</span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="brief "><p class="paragraph">Main handling of <a href="handle-state.html">state</a>. In case when this <a href="handle-state.html">state</a> leads to another <a href="../[common]-state/index.html">State</a> and <a href="handle-state.html">handleState</a> returns not null <a href="../[common]-state/index.html">State</a> it is assumed that chain is not completed.</p></div></div> </div>
</div>
</div>
</div>
</div>
</div>
<h2 class="">Inheritors</h2>
<div class="table" data-togglable="Inheritors"><a data-name="1569721837%2FInheritors%2F1737121690" anchor-label="CheckableHandlerHolder" id="1569721837%2FInheritors%2F1737121690" data-filterable-set=":micro_utils.dokka:dokkaHtml/androidMain :micro_utils.dokka:dokkaHtml/commonMain :micro_utils.dokka:dokkaHtml/jvmMain"></a>
<div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/androidMain :micro_utils.dokka:dokkaHtml/commonMain :micro_utils.dokka:dokkaHtml/jvmMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/androidMain :micro_utils.dokka:dokkaHtml/commonMain :micro_utils.dokka:dokkaHtml/jvmMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><span data-unresolved-link="dev.inmo.micro_utils.fsm.common/CheckableHandlerHolder///PointingToDeclaration/">CheckableHandlerHolder</span></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1569721837%2FInheritors%2F1737121690"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div></div>
</div>
</div>
<a data-name="523246684%2FInheritors%2F1737121690" anchor-label="StatesMachine" id="523246684%2FInheritors%2F1737121690" data-filterable-set=":micro_utils.dokka:dokkaHtml/androidMain :micro_utils.dokka:dokkaHtml/commonMain :micro_utils.dokka:dokkaHtml/jvmMain"></a>
<div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/androidMain :micro_utils.dokka:dokkaHtml/commonMain :micro_utils.dokka:dokkaHtml/jvmMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/androidMain :micro_utils.dokka:dokkaHtml/commonMain :micro_utils.dokka:dokkaHtml/jvmMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><span data-unresolved-link="dev.inmo.micro_utils.fsm.common/StatesMachine///PointingToDeclaration/">StatesMachine</span></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="523246684%2FInheritors%2F1737121690"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div></div>
</div>
</div>
</div>
<h2 class="tabbedcontent">Extensions</h2>
<div class="table" data-togglable="Extensions"><a data-name="1180048627%2FExtensions%2F1737121690" anchor-label="holder" id="1180048627%2FExtensions%2F1737121690" data-filterable-set=":micro_utils.dokka:dokkaHtml/androidMain :micro_utils.dokka:dokkaHtml/commonMain :micro_utils.dokka:dokkaHtml/jvmMain"></a>
<div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/androidMain :micro_utils.dokka:dokkaHtml/commonMain :micro_utils.dokka:dokkaHtml/jvmMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/androidMain :micro_utils.dokka:dokkaHtml/commonMain :micro_utils.dokka:dokkaHtml/jvmMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><span data-unresolved-link="dev.inmo.micro_utils.fsm.common//holder/dev.inmo.micro_utils.fsm.common.StatesHandler[TypeParam(bounds=[TypeParam(bounds=[dev.inmo.micro_utils.fsm.common.State])]),TypeParam(bounds=[dev.inmo.micro_utils.fsm.common.State])]#kotlin.Boolean/PointingToDeclaration/"><span><span>holder</span></span></span></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1180048627%2FExtensions%2F1737121690"></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 jvm-like" data-filterable-current=":micro_utils.dokka:dokkaHtml/androidMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/androidMain" data-active="" data-toggle=":micro_utils.dokka:dokkaHtml/androidMain">android</button><button class="platform-bookmark common-like" data-filterable-current=":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain" data-toggle=":micro_utils.dokka:dokkaHtml/commonMain">common</button><button class="platform-bookmark jvm-like" data-filterable-current=":micro_utils.dokka:dokkaHtml/jvmMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/jvmMain" data-toggle=":micro_utils.dokka:dokkaHtml/jvmMain">jvm</button></div>
<div class="content sourceset-depenent-content" data-active="" data-togglable=":micro_utils.dokka:dokkaHtml/androidMain"><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../[android]holder.html">I</a><span class="token operator"> : </span><a href="../[android]holder.html">O</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../[android]holder.html">O</a><span class="token operator"> : </span><a href="../[android]-state/index.html">State</a><span class="token operator">&gt; </span><a href="../[android]-states-handler/index.html">StatesHandler</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../[android]holder.html">I</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../[android]holder.html">O</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="../[android]holder.html"><span class="token function">holder</span></a><span class="token punctuation">(</span>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 class="token punctuation">)</span><span class="token operator">: </span><a href="../[android]-customizable-handler-holder/index.html">CustomizableHandlerHolder</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../[android]holder.html">O</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../[android]holder.html">O</a><span class="token operator">&gt;</span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../[android]holder.html">I</a><span class="token operator"> : </span><a href="../[android]holder.html">O</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../[android]holder.html">O</a><span class="token operator"> : </span><a href="../[android]-state/index.html">State</a><span class="token operator">&gt; </span><a href="../[android]-states-handler/index.html">StatesHandler</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../[android]holder.html">I</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../[android]holder.html">O</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="../[android]holder.html"><span class="token function">holder</span></a><span class="token punctuation">(</span><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="../[android]-state/index.html">State</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token punctuation">)</span><span class="token operator">: </span><a href="../[android]-customizable-handler-holder/index.html">CustomizableHandlerHolder</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../[android]holder.html">O</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../[android]holder.html">O</a><span class="token operator">&gt;</span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div><div class="content sourceset-depenent-content" 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">&lt;</span><span class="token keyword"></span><a href="../[common]holder.html">I</a><span class="token operator"> : </span><a href="../[common]holder.html">O</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../[common]holder.html">O</a><span class="token operator"> : </span><a href="../[common]-state/index.html">State</a><span class="token operator">&gt; </span><a href="index.html">StatesHandler</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../[common]holder.html">I</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../[common]holder.html">O</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="../[common]holder.html"><span class="token function">holder</span></a><span class="token punctuation">(</span>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 class="token punctuation">)</span><span class="token operator">: </span><a href="../[common]-customizable-handler-holder/index.html">CustomizableHandlerHolder</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../[common]holder.html">O</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../[common]holder.html">O</a><span class="token operator">&gt;</span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../[common]holder.html">I</a><span class="token operator"> : </span><a href="../[common]holder.html">O</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../[common]holder.html">O</a><span class="token operator"> : </span><a href="../[common]-state/index.html">State</a><span class="token operator">&gt; </span><a href="index.html">StatesHandler</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../[common]holder.html">I</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../[common]holder.html">O</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="../[common]holder.html"><span class="token function">holder</span></a><span class="token punctuation">(</span><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="../[common]-state/index.html">State</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token punctuation">)</span><span class="token operator">: </span><a href="../[common]-customizable-handler-holder/index.html">CustomizableHandlerHolder</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../[common]holder.html">O</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../[common]holder.html">O</a><span class="token operator">&gt;</span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div><div class="content sourceset-depenent-content" data-togglable=":micro_utils.dokka:dokkaHtml/jvmMain"><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../[jvm]holder.html">I</a><span class="token operator"> : </span><a href="../[jvm]holder.html">O</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../[jvm]holder.html">O</a><span class="token operator"> : </span><a href="../[jvm]-state/index.html">State</a><span class="token operator">&gt; </span><a href="../[jvm]-states-handler/index.html">StatesHandler</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../[jvm]holder.html">I</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../[jvm]holder.html">O</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="../[jvm]holder.html"><span class="token function">holder</span></a><span class="token punctuation">(</span>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 class="token punctuation">)</span><span class="token operator">: </span><a href="../[jvm]-customizable-handler-holder/index.html">CustomizableHandlerHolder</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../[jvm]holder.html">O</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../[jvm]holder.html">O</a><span class="token operator">&gt;</span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../[jvm]holder.html">I</a><span class="token operator"> : </span><a href="../[jvm]holder.html">O</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../[jvm]holder.html">O</a><span class="token operator"> : </span><a href="../[jvm]-state/index.html">State</a><span class="token operator">&gt; </span><a href="../[jvm]-states-handler/index.html">StatesHandler</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../[jvm]holder.html">I</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../[jvm]holder.html">O</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="../[jvm]holder.html"><span class="token function">holder</span></a><span class="token punctuation">(</span><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="../[jvm]-state/index.html">State</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token punctuation">)</span><span class="token operator">: </span><a href="../[jvm]-customizable-handler-holder/index.html">CustomizableHandlerHolder</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../[jvm]holder.html">O</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../[jvm]holder.html">O</a><span class="token operator">&gt;</span><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div> </div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer"><span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2022 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span></div>
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink