kotlinpoet-metadata/com.squareup.kotlinpoet.metadata/ImmutableKmEffect

ImmutableKmEffect

Immutable representation of KmEffect.

Represents an effect (a part of the contract of a Kotlin function).

Contracts are an internal feature of the standard Kotlin library, and their behavior and/or binary format may change in a subsequent release.

data class ImmutableKmEffect

Functions

component1

operator fun component1(): KmEffectType

component2

operator fun component2(): KmEffectInvocationKind?

component3

operator fun component3(): List<ImmutableKmEffectExpression>

component4

operator fun component4(): ImmutableKmEffectExpression?

copy

fun copy(type: KmEffectType, invocationKind: KmEffectInvocationKind?, constructorArguments: List<ImmutableKmEffectExpression>, conclusion: ImmutableKmEffectExpression?): ImmutableKmEffect

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toMutable

fun toMutable(): KmEffect

toString

open override fun toString(): String

Properties

conclusion

Conclusion of the effect. If this value is set, the effect represents an implication with this value as the right-hand side.

val conclusion: ImmutableKmEffectExpression?

constructorArguments

Arguments of the effect constructor, i.e. the constant value for the KmEffectType.RETURNS_CONSTANT effect, or the parameter reference for the KmEffectType.CALLS effect.

val constructorArguments: List<ImmutableKmEffectExpression>

invocationKind

Optional number of invocations of the lambda parameter of this function, specified further in the effect expression.

val invocationKind: KmEffectInvocationKind?

type

Type of the effect

val type: KmEffectType