Deployed 2d66716 with MkDocs version: 1.5.3

api/0.x/backstack/com.slack.circuit.backstack/-back-stack/-record/await-result.html

@@ -63,7 +63,7 @@
   <div class="cover ">
     <h1 class="cover"><span>await</span><wbr><span><span>Result</span></span></h1>
   </div>
-  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":backstack:dokkaHtmlPartial/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="await-result.html"><span class="token function">awaitResult</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">key<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../../../circuit-runtime-screen/com.slack.circuit.runtime.screen/-pop-result/index.html">PopResult</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/slackhq/circuit//tree/main/backstack/src/commonMain/kotlin/com/slack/circuit/backstack/BackStack.kt#L109">source</a>)</span></span></div><p class="paragraph">Awaits a <a href="../../../../circuit-runtime-screen/com.slack.circuit.runtime.screen/-pop-result/index.html">PopResult</a> produced by the record that previously sat on top of the stack above this one. Returns null if no result was produced.</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":backstack:dokkaHtmlPartial/commonMain" data-filterable-set=":backstack:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>key</span></span></u></div></span></div><div><div class="title"><p class="paragraph">The key that was used to tag the result. This ensures that only the caller that requested a result when pushing the previous record can receive it.</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=":backstack:dokkaHtmlPartial/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="await-result.html"><span class="token function">awaitResult</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">key<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../../../circuit-runtime-screen/com.slack.circuit.runtime.screen/-pop-result/index.html">PopResult</a><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/slackhq/circuit//tree/main/backstack/src/commonMain/kotlin/com/slack/circuit/backstack/BackStack.kt#L117">source</a>)</span></span></div><p class="paragraph">Awaits a <a href="../../../../circuit-runtime-screen/com.slack.circuit.runtime.screen/-pop-result/index.html">PopResult</a> produced by the record that previously sat on top of the stack above this one. Returns null if no result was produced.</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":backstack:dokkaHtmlPartial/commonMain" data-filterable-set=":backstack:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>key</span></span></u></div></span></div><div><div class="title"><p class="paragraph">The key that was used to tag the result. This ensures that only the caller that requested a result when pushing the previous record can receive it.</p></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>© 2024 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>

api/0.x/backstack/com.slack.circuit.backstack/-back-stack/-record/index.html

@@ -62,7 +62,7 @@
   <div class="breadcrumbs"><a href="../../../index.html">backstack</a><span class="delimiter">/</span><a href="../../index.html">com.slack.circuit.backstack</a><span class="delimiter">/</span><a href="../index.html">BackStack</a><span class="delimiter">/</span><span class="current">Record</span></div>
   <div class="cover ">
     <h1 class="cover"><span><span>Record</span></span></h1>
-    <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":backstack:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://developer.android.com/reference/kotlin/androidx/compose/runtime/Stable.html"><span class="token annotation builtin">Stable</span></a></div></div><span class="token keyword">interface </span><a href="index.html">Record</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/slackhq/circuit//tree/main/backstack/src/commonMain/kotlin/com/slack/circuit/backstack/BackStack.kt#L89">source</a>)</span></span></div><h4 class="">Inheritors</h4><div class="table"><div class="table-row" data-filterable-current=":backstack:dokkaHtmlPartial/commonMain" data-filterable-set=":backstack:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../../-saveable-back-stack/-record/index.html">Record</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=":backstack:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://developer.android.com/reference/kotlin/androidx/compose/runtime/Stable.html"><span class="token annotation builtin">Stable</span></a></div></div><span class="token keyword">interface </span><a href="index.html">Record</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/slackhq/circuit//tree/main/backstack/src/commonMain/kotlin/com/slack/circuit/backstack/BackStack.kt#L97">source</a>)</span></span></div><h4 class="">Inheritors</h4><div class="table"><div class="table-row" data-filterable-current=":backstack:dokkaHtmlPartial/commonMain" data-filterable-set=":backstack:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../../-saveable-back-stack/-record/index.html">Record</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></div>

api/0.x/backstack/com.slack.circuit.backstack/-back-stack/-record/key.html

@@ -63,7 +63,7 @@
   <div class="cover ">
     <h1 class="cover"><span><span>key</span></span></h1>
   </div>
-  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":backstack:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">val </span><a href="key.html">key</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/slackhq/circuit//tree/main/backstack/src/commonMain/kotlin/com/slack/circuit/backstack/BackStack.kt#L97">source</a>)</span></span></div><p class="paragraph">A value that identifies this record uniquely, even if it shares the same <a href="screen.html">screen</a> with another record. This key may be used by <a href="../../-back-stack-record-local-provider/index.html">BackStackRecordLocalProvider</a>s to associate presentation data with a record across composition recreation.</p><p class="paragraph"><a href="key.html">key</a> MUST NOT change for the life of the record.</p></div></div>
+  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":backstack:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">val </span><a href="key.html">key</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/slackhq/circuit//tree/main/backstack/src/commonMain/kotlin/com/slack/circuit/backstack/BackStack.kt#L105">source</a>)</span></span></div><p class="paragraph">A value that identifies this record uniquely, even if it shares the same <a href="screen.html">screen</a> with another record. This key may be used by <a href="../../-back-stack-record-local-provider/index.html">BackStackRecordLocalProvider</a>s to associate presentation data with a record across composition recreation.</p><p class="paragraph"><a href="key.html">key</a> MUST NOT change for the life of the record.</p></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 class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>

api/0.x/backstack/com.slack.circuit.backstack/-back-stack/-record/screen.html

@@ -63,7 +63,7 @@
   <div class="cover ">
     <h1 class="cover"><span><span>screen</span></span></h1>
   </div>
-  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":backstack:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">val </span><a href="screen.html">screen</a><span class="token operator">: </span><a href="../../../../circuit-runtime-screen/com.slack.circuit.runtime.screen/-screen/index.html">Screen</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/slackhq/circuit//tree/main/backstack/src/commonMain/kotlin/com/slack/circuit/backstack/BackStack.kt#L100">source</a>)</span></span></div><p class="paragraph">The <a href="../../../../circuit-runtime-screen/com.slack.circuit.runtime.screen/-screen/index.html">Screen</a> that should present this record.</p></div></div>
+  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":backstack:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">val </span><a href="screen.html">screen</a><span class="token operator">: </span><a href="../../../../circuit-runtime-screen/com.slack.circuit.runtime.screen/-screen/index.html">Screen</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/slackhq/circuit//tree/main/backstack/src/commonMain/kotlin/com/slack/circuit/backstack/BackStack.kt#L108">source</a>)</span></span></div><p class="paragraph">The <a href="../../../../circuit-runtime-screen/com.slack.circuit.runtime.screen/-screen/index.html">Screen</a> that should present this record.</p></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 class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>

api/0.x/backstack/com.slack.circuit.backstack/-back-stack/index.html

@@ -62,7 +62,7 @@
   <div class="breadcrumbs"><a href="../../index.html">backstack</a><span class="delimiter">/</span><a href="../index.html">com.slack.circuit.backstack</a><span class="delimiter">/</span><span class="current">BackStack</span></div>
   <div class="cover ">
     <h1 class="cover"><span>Back</span><wbr><span><span>Stack</span></span></h1>
-    <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":backstack:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://developer.android.com/reference/kotlin/androidx/compose/runtime/Stable.html"><span class="token annotation builtin">Stable</span></a></div></div><span class="token keyword">interface </span><a href="index.html">BackStack</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">R</a><span class="token operator"> : </span><a href="-record/index.html">BackStack.Record</a><span class="token operator">&gt;</span> : <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-iterable/index.html">Iterable</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">R</a><span class="token operator">&gt; </span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/slackhq/circuit//tree/main/backstack/src/commonMain/kotlin/com/slack/circuit/backstack/BackStack.kt#L28">source</a>)</span></span></div><p class="paragraph">A caller-supplied stack of <a href="-record/index.html">Record</a>s for presentation with a <code class="lang-kotlin">Navigator</code>. Iteration order is top-first (first element is the top of the stack).</p><h4 class="">Inheritors</h4><div class="table"><div class="table-row" data-filterable-current=":backstack:dokkaHtmlPartial/commonMain" data-filterable-set=":backstack:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-saveable-back-stack/index.html">SaveableBackStack</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=":backstack:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://developer.android.com/reference/kotlin/androidx/compose/runtime/Stable.html"><span class="token annotation builtin">Stable</span></a></div></div><span class="token keyword">interface </span><a href="index.html">BackStack</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">R</a><span class="token operator"> : </span><a href="-record/index.html">BackStack.Record</a><span class="token operator">&gt;</span> : <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-iterable/index.html">Iterable</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">R</a><span class="token operator">&gt; </span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/slackhq/circuit//tree/main/backstack/src/commonMain/kotlin/com/slack/circuit/backstack/BackStack.kt#L31">source</a>)</span></span></div><p class="paragraph">A caller-supplied stack of <a href="-record/index.html">Record</a>s for presentation with a <code class="lang-kotlin">Navigator</code>. Iteration order is top-first (first element is the top of the stack).</p><h4 class="">Inheritors</h4><div class="table"><div class="table-row" data-filterable-current=":backstack:dokkaHtmlPartial/commonMain" data-filterable-set=":backstack:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-saveable-back-stack/index.html">SaveableBackStack</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 &amp; Extensions</button></div>
@@ -192,7 +192,7 @@ <h2 class="">Functions</h2>
                   </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=":backstack:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="pop-until.html"><span class="token function">popUntil</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">predicate<span class="token operator">: </span><span class="token punctuation">(</span><span class="token keyword"></span><a href="index.html">R</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></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Pop records off the top of the backstack until one is found that matches the given predicate.</p></div></div></div>
+                  <div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":backstack:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="pop-until.html"><span class="token function">popUntil</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">predicate<span class="token operator">: </span><span class="token punctuation">(</span><span class="token keyword"></span><a href="index.html">R</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></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.collections.immutable/ImmutableList///PointingToDeclaration/">ImmutableList</span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">R</a><span class="token operator">&gt;</span></div><div class="brief "><p class="paragraph">Pop records off the top of the backstack until one is found that matches the given predicate.</p></div></div></div>
                 </div>
               </div>
             </div>