InsanusMokrassar/MicroUtils
1
0
Fork 0
mirror of https://github.com/InsanusMokrassar/MicroUtils.git synced 2025-09-06 08:40:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

deploy: 63c8f642ec

Browse Source
This commit is contained in:
InsanusMokrassar
2024-06-19 20:06:26 +00:00
parent e2728d7f3f
commit db1ef54f1f
4645 changed files with 4816 additions and 4881 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
micro_utils.dokka/dev.inmo.micro_utils.coroutines/safely.html
View File

@@ -45,7 +45,7 @@
</a>
</div>
<div class="library-version">
0.20.52 </div>
0.21.0 </div>
</div>
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector common-like" data-active="" data-filter=":micro_utils.dokka:dokkaHtml/commonMain">common</button>
@@ -61,12 +61,12 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="micro_utils.dokka::dev.inmo.micro_utils.coroutines//safely/#kotlin.coroutines.SuspendFunction1[kotlin.Throwable,TypeParam(bounds=[kotlin.Any?])]#kotlin.coroutines.SuspendFunction1[kotlinx.coroutines.CoroutineScope,TypeParam(bounds=[kotlin.Any?])]/PointingToDeclaration//-1478683138">
<div class="main-content" data-page-type="member" id="content" pageIds="micro_utils.dokka::dev.inmo.micro_utils.coroutines//safely/#kotlin.coroutines.SuspendFunction1[kotlin.Throwable,TypeParam(bounds=[kotlin.Any?])]#kotlin.coroutines.SuspendFunction0[TypeParam(bounds=[kotlin.Any?])]/PointingToDeclaration//-1478683138">
<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><span class="current">safely</span></div>
<div class="cover ">
<h1 class="cover"><span><span>safely</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:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><a href="safely.html">T</a><span class="token operator">&gt; </span><a href="safely.html"><span class="token function">safely</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">onException<span class="token operator">: </span><a href="-exception-handler/index.html">ExceptionHandler</a><span class="token operator">&lt;</span><a href="safely.html">T</a><span class="token operator">&gt;</span><span class="token operator"> = </span>defaultSafelyExceptionHandler<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"> -&gt; </span><a href="safely.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="safely.html">T</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//coroutines/src/commonMain/kotlin/dev/inmo/micro_utils/coroutines/HandleSafely.kt#L99">source</a>)</span></span></div><p class="paragraph">It will run <a href="safely.html">block</a> inside of <span data-unresolved-link="kotlinx.coroutines//supervisorScope/#kotlin.coroutines.SuspendFunction1[kotlinx.coroutines.CoroutineScope,TypeParam(bounds=[kotlin.Any?])]/PointingToDeclaration/">supervisorScope</span> to avoid problems with catching of exceptions</p><p class="paragraph">Priorities of <a href="-exception-handler/index.html">ExceptionHandler</a>s:</p><ul><li><p class="paragraph"><a href="safely.html">onException</a> In case if custom (will be used anyway if not <a href="default-safely-exception-handler.html">defaultSafelyExceptionHandler</a>)</p></li><li><p class="paragraph"><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.coroutines/-coroutine-context/get.html">CoroutineContext.get</a> with SafelyExceptionHandlerKey as key</p></li><li><p class="paragraph"><a href="default-safely-exception-handler.html">defaultSafelyExceptionHandler</a></p></li></ul><p class="paragraph">Remember, that <a href="-exception-handler/index.html">ExceptionHandler</a> from <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.coroutines/-coroutine-context/get.html">CoroutineContext.get</a> will be used anyway if it is available. After it will be called <a href="safely.html">onException</a></p><h4 class="">Parameters</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><u><span>on</span><wbr></wbr><span><span>Exception</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Will be called when happen exception inside of <a href="safely.html">block</a>. By default will throw exception - this exception will be available for catching</p></div></div></div></div></div><h4 class="">See also</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-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></div><div></div></div></div><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="safely-without-exceptions.html"><span>safely</span><wbr></wbr><span>Without</span><wbr></wbr><span><span>Exceptions</span></span></a></div></span></div><div></div></div></div><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="safely-with-context-exception-handler.html"><span>safely</span><wbr></wbr><span>With</span><wbr></wbr><span>Context</span><wbr></wbr><span>Exception</span><wbr></wbr><span><span>Handler</span></span></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">inline suspend </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><a href="safely.html">T</a><span class="token operator">&gt; </span><a href="safely.html"><span class="token function">safely</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">onException<span class="token operator">: </span><a href="-exception-handler/index.html">ExceptionHandler</a><span class="token operator">&lt;</span><a href="safely.html">T</a><span class="token operator">&gt;</span><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"> -&gt; </span><a href="safely.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="safely.html">T</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//coroutines/src/commonMain/kotlin/dev/inmo/micro_utils/coroutines/HandleSafely.kt#L97">source</a>)</span></span></div><p class="paragraph">Calls <a href="run-catching-safely.html">runCatchingSafely</a> and getting the result via <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/index.html">Result.getOrThrow</a></p><h4 class="">See also</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="run-catching-safely.html"><span>run</span><wbr></wbr><span>Catching</span><wbr></wbr><span><span>Safely</span></span></a></div></span></div><div></div></div></div></div><hr><div class="symbol monospace"><span class="token keyword">inline suspend </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><a href="safely.html">T</a><span class="token operator">&gt; </span><a href="safely.html"><span class="token function">safely</span></a><span class="token punctuation">(</span><span class="parameters "><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"> -&gt; </span><a href="safely.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="safely.html">T</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//coroutines/src/commonMain/kotlin/dev/inmo/micro_utils/coroutines/HandleSafely.kt#L107">source</a>)</span></span></div><p class="paragraph">Calls <a href="safely.html">safely</a> with passing of <a href="default-safely-exception-handler.html">defaultSafelyExceptionHandler</a> as <code class="lang-kotlin">onException</code></p><h4 class="">See also</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="run-catching-safely.html"><span>run</span><wbr></wbr><span>Catching</span><wbr></wbr><span><span>Safely</span></span></a></div></span></div><div></div></div></div></div><hr><div class="symbol monospace"><span class="token keyword">inline suspend </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><a href="safely.html">T</a><span class="token punctuation">, </span><a href="safely.html">R</a><span class="token operator">&gt; </span><a href="safely.html">R</a><span class="token punctuation">.</span><a href="safely.html"><span class="token function">safely</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">block<span class="token operator">: </span><span class="token keyword">suspend </span><a href="safely.html">R</a><span class="token punctuation">.</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><a href="safely.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="safely.html">T</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//coroutines/src/commonMain/kotlin/dev/inmo/micro_utils/coroutines/HandleSafely.kt#L110">source</a>)</span></span></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span