Capture

Dokka 2.2.0 generates this reference of the Kotlin spec builder during each site build from the Kotlin sources, and its summary lists every class and function. The guide shows the builder in use, the Java builder's reference covers the handles, types and expressions it shares, and the extensions read the data.

@TrackCaller

class Capture<H : Field<*>> : PropertyDelegateProvider<Any?, ReadOnlyProperty<Any?, H>>

A capture for a line pattern, made by capture and optionalCapture of a scope. As a property delegate it names the entry after the property, or after the name given to capture, and declares that name, which must be new in the builder, as Iris.declare.

Functions

named

fun named(name: String): H

Declares the entry name and returns its handle, which prints as a capture in a pattern.

provideDelegate

open operator override fun provideDelegate(thisRef: Any?, property: KProperty<*>): ReadOnlyProperty<Any?, H>