commonMain.pro.respawn.flowmvi.dsl.LambdaIntent.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of core-jvm Show documentation

A Kotlin Multiplatform MVI library based on plugins that is simple, fast, powerful & flexible

There is a newer version: 3.0.0

package pro.respawn.flowmvi.dsl

import pro.respawn.flowmvi.api.FlowMVIDSL
import pro.respawn.flowmvi.api.IntentReceiver
import pro.respawn.flowmvi.api.MVIAction
import pro.respawn.flowmvi.api.MVIIntent
import pro.respawn.flowmvi.api.MVIState
import pro.respawn.flowmvi.api.PipelineContext
import pro.respawn.flowmvi.plugins.reduce
import kotlin.jvm.JvmInline

/**
 * An intent that is a holder for a [block] that acts as this intent's logic.
 * LambdaIntents enable MVVM+ -style declaration of your [pro.respawn.flowmvi.api.Store].
 *
 * * Use [reduceLambdas] to handle lambda intents in your store.
 * * Use [send] to send lambda intents and define a block for them to be processed.
 *
 * **When using lambda intents, some plugins will become useless (as they'll no longer know what's inside the lambda),
 * e.g. logging of lambda intents**
 */
@JvmInline
public value class LambdaIntent(
    private val block: suspend PipelineContext, A>.() -> Unit
) : MVIIntent {

    /**
     * Invoke the [block] of this intent
     */
    internal suspend operator fun PipelineContext, A>.invoke(): Unit = block(this)
    override fun toString(): String = "LambdaIntent"
}

/**
 * An alias for [pro.respawn.flowmvi.api.IntentReceiver.send] ([LambdaIntent] ([block]))
 */
public fun  IntentReceiver>.send(
    @BuilderInference block: suspend PipelineContext, A>.() -> Unit
): Unit = intent(LambdaIntent(block))

/**
 * An alias for [pro.respawn.flowmvi.api.IntentReceiver.intent] ([LambdaIntent] ([block]))
 */
public fun  IntentReceiver>.intent(
    @BuilderInference block: suspend PipelineContext, A>.() -> Unit
): Unit = send(block)

/**
 * Install a new [pro.respawn.flowmvi.plugins.reducePlugin] that is tailored for [LambdaIntent]s.
 */
@FlowMVIDSL
public fun  StoreBuilder, A>.reduceLambdas(): Unit = reduce {
    with(it) { invoke() }
}