kiscord-core/kiscord.builder

Package-level declarations

Builder interfaces and Plugin mechanism

Types

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.PROPERTY])

annotation class BuilderDsl

Denotes builder DSL to prevent method clashing

interface BuilderFor<out T>

Abstract builder for T

interface BuilderSpec<out Value, out Builder : BuilderFor<Value>>

ConfigurationChain

value class ConfigurationChain<in T>(blocks: Collection<T.() -> Unit>) : Collection<T.() -> Unit>

PluggableBuilder

interface PluggableBuilder<out TScope : PluginScope> : BuilderFor<TScope> , TypedAttributesScope

interface Plugin<out TConfig : Any, TPlugin : Any, in TScope : PluginScope>

interface PluginScope : TypedAttributesScope

abstract class TypedAttribute<out T>(classifier: KClassifier)

TypedAttributes

interface TypedAttributes

TypedAttributesScope

interface TypedAttributesScope

fun interface UpdaterFor<Value : Any>

Functions

inline fun <Builder : BuilderFor<*>> BuilderSpec<*, Builder>.builder(block: Builder.() -> Unit): Builder

fun <TFeature : Any, TScope : PluginScope> TScope.featureOrNull(plugin: Plugin<*, TFeature, TScope>): TFeature?

operator fun <TFeature : Any, TScope : PluginScope> TScope.get(plugin: Plugin<*, TFeature, TScope>): TFeature

operator fun <T> TypedAttribute<T>.getValue(attributes: TypedAttributes, property: KProperty<*>): T

operator fun <T> TypedAttribute<T>.getValue(scope: TypedAttributesScope, property: KProperty<*>): T

inline fun <TScope : PluginScope> PluggableBuilder<TScope>.install(name: String, crossinline block: TScope.() -> Unit)

inline operator fun <Value, Builder : BuilderFor<Value>> BuilderSpec<Value, Builder>.invoke(block: Builder.() -> Unit): Value

fun <TScope : PluginScope> PluggableBuilder<TScope>.maybeInstall(plugin: Plugin<*, *, TScope>)

fun TypedAttributes.readOnly(): TypedAttributes

operator fun <T> TypedAttribute<T>.setValue(attributes: TypedAttributes, property: KProperty<*>, value: T?)

operator fun <T> TypedAttribute<T>.setValue(scope: TypedAttributesScope, property: KProperty<*>, value: T?)