chore: fix lint (2)

respawn-app · Dec 8, 2024 · 588e694 · 588e694
1 parent 12f412e
commit 588e694
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 7 deletions.
diff --git a/benchmarks/src/jvmMain/kotlin/pro/respawn/flowmvi/benchmarks/Main.kt b/benchmarks/src/jvmMain/kotlin/pro/respawn/flowmvi/benchmarks/Main.kt
@@ -8,6 +8,9 @@ import kotlinx.coroutines.yield
 import pro.respawn.flowmvi.benchmarks.setup.BenchmarkIntent.Increment
 import pro.respawn.flowmvi.benchmarks.setup.atomic.atomicParallelStore
 
+/**
+ * run an infinite process for profiling
+ */
 fun main() = runBlocking {
     println(ProcessHandle.current().pid())
     val store = atomicParallelStore(this)

diff --git a/benchmarks/src/jvmMain/kotlin/pro/respawn/flowmvi/benchmarks/setup/BenchmarkState.kt b/benchmarks/src/jvmMain/kotlin/pro/respawn/flowmvi/benchmarks/setup/BenchmarkState.kt
@@ -2,6 +2,6 @@ package pro.respawn.flowmvi.benchmarks.setup
 
 import pro.respawn.flowmvi.api.MVIState
 
-data class BenchmarkState(
+internal data class BenchmarkState(
     val counter: Int = 0
 ) : MVIState
diff --git a/...setup/channelbased/TraditionalMVIStore.kt → ...nnelbased/ChannelBasedTraditionalStore.kt b/...setup/channelbased/TraditionalMVIStore.kt → ...nnelbased/ChannelBasedTraditionalStore.kt
diff --git a/.../src/jvmMain/kotlin/pro/respawn/flowmvi/benchmarks/setup/fluxo/FluxoStartStopBenchmark.kt b/.../src/jvmMain/kotlin/pro/respawn/flowmvi/benchmarks/setup/fluxo/FluxoStartStopBenchmark.kt
@@ -11,7 +11,7 @@ import org.openjdk.jmh.annotations.Threads
 @Threads(Threads.MAX)
 @Suppress("unused")
 @State(Scope.Benchmark)
-class FluxoStartStopBenchmark {
+internal class FluxoStartStopBenchmark {
 
     @OptIn(ExperimentalFluxoApi::class)
     @Benchmark

diff --git a/core/src/commonMain/kotlin/pro/respawn/flowmvi/api/ImmediateStateReceiver.kt b/core/src/commonMain/kotlin/pro/respawn/flowmvi/api/ImmediateStateReceiver.kt
@@ -2,14 +2,20 @@ package pro.respawn.flowmvi.api
 
 import kotlinx.coroutines.flow.StateFlow
 import pro.respawn.flowmvi.annotation.InternalFlowMVIAPI
+import pro.respawn.flowmvi.dsl.updateStateImmediate
 
 /**
  * [StateReceiver] version that can only accept immediate state updates. It is recommended to use [StateReceiver] and
  * its methods if possible. See the method docs for details
  */
 public interface ImmediateStateReceiver<S : MVIState> : StateProvider<S> {
 
-    @FlowMVIDSL
+    /**
+     * Directly compare and set the current state.
+     *
+     * Please read [updateStateImmediate] to learn about repercussions of using this.
+     */
+    @InternalFlowMVIAPI
     public fun compareAndSet(old: S, new: S): Boolean
 
     @InternalFlowMVIAPI

diff --git a/core/src/commonMain/kotlin/pro/respawn/flowmvi/dsl/StateDsl.kt b/core/src/commonMain/kotlin/pro/respawn/flowmvi/dsl/StateDsl.kt
@@ -1,5 +1,6 @@
 package pro.respawn.flowmvi.dsl
 
+import pro.respawn.flowmvi.annotation.InternalFlowMVIAPI
 import pro.respawn.flowmvi.api.DelicateStoreApi
 import pro.respawn.flowmvi.api.FlowMVIDSL
 import pro.respawn.flowmvi.api.ImmediateStateReceiver
@@ -42,17 +43,15 @@ public inline val <S : MVIState> StateProvider<S>.state get() = states.value
  * @see StateReceiver.updateState
  * @see StateReceiver.withState
  */
-@OptIn(DelicateStoreApi::class)
+@OptIn(DelicateStoreApi::class, InternalFlowMVIAPI::class)
 @FlowMVIDSL
 public inline fun <S : MVIState> ImmediateStateReceiver<S>.updateStateImmediate(
     @BuilderInference transform: S.() -> S
 ) {
     contract {
         callsInPlace(transform, InvocationKind.AT_LEAST_ONCE)
     }
-    while (true) {
-        if (compareAndSet(state, transform(state))) return
-    }
+    while (true) if (compareAndSet(state, transform(state))) return
 }
 
 /**