kotlinpoet-metadata/com.squareup.kotlinpoet.metadata

Package com.squareup.kotlinpoet.metadata

Types

ImmutableKmClass

Immutable representation of KmClass.

Represents a Kotlin class.

data class ImmutableKmClass : ImmutableKmDeclarationContainer, ImmutableKmWithFlags

ImmutableKmConstructor

Immutable representation of KmConstructor.

Represents a constructor of a Kotlin class.

data class ImmutableKmConstructor : ImmutableKmWithFlags

ImmutableKmContract

Immutable representation of KmContract.

Represents a 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 ImmutableKmContract

ImmutableKmDeclarationContainer

Immutable representation of KmDeclarationContainer.

Represents a Kotlin declaration container, such as a class or a package fragment.

interface ImmutableKmDeclarationContainer

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

ImmutableKmEffectExpression

Immutable representation of KmEffectExpression.

Represents an effect expression, the contents of 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 ImmutableKmEffectExpression : ImmutableKmWithFlags

ImmutableKmFlexibleTypeUpperBound

Immutable representation of KmFlexibleTypeUpperBound.

Represents an upper bound of a flexible Kotlin type.

data class ImmutableKmFlexibleTypeUpperBound

ImmutableKmFunction

Immutable representation of KmFunction.

Represents a Kotlin function declaration.

data class ImmutableKmFunction : ImmutableKmWithFlags

ImmutableKmLambda

Immutable representation of KmLambda.

Represents a synthetic class generated for a Kotlin lambda.

data class ImmutableKmLambda

ImmutableKmPackage

Immutable representation of KmPackage.

Represents a Kotlin package fragment, including single file facades and multi-file class parts.

data class ImmutableKmPackage : ImmutableKmDeclarationContainer

ImmutableKmProperty

Immutable representation of KmProperty.

Represents a Kotlin property declaration.

data class ImmutableKmProperty : ImmutableKmWithFlags

ImmutableKmType

Immutable representation of KmType.

Represents a type.

data class ImmutableKmType : ImmutableKmWithFlags

ImmutableKmTypeAlias

Immutable representation of KmTypeAlias.

Represents a Kotlin type alias declaration.

data class ImmutableKmTypeAlias : ImmutableKmWithFlags

ImmutableKmTypeParameter

Immutable representation of KmTypeParameter.

Represents a type parameter of a Kotlin class, function, property or type alias.

data class ImmutableKmTypeParameter : ImmutableKmWithFlags

ImmutableKmTypeProjection

Immutable representation of KmTypeProjection.

Represents type projection used in a type argument of the type based on a class or on a type alias. For example, in MutableMap<in String?, *>, in String? is the type projection which is the first type argument of the type.

data class ImmutableKmTypeProjection

ImmutableKmValueParameter

Immutable representation of KmValueParameter.

Represents a value parameter of a Kotlin constructor, function or property setter.

data class ImmutableKmValueParameter : ImmutableKmWithFlags

ImmutableKmVersionRequirement

Immutable representation of KmVersionRequirement.

Represents a version requirement on a Kotlin declaration.

Version requirement is an internal feature of the Kotlin compiler and the standard Kotlin library, enabled for example with the internal kotlin.internal.RequireKotlin annotation.

data class ImmutableKmVersionRequirement : KmVersionRequirementVisitor

ImmutableKmWithFlags

Represents an immutable kotlinx-metadata type with a common Flags property.

interface ImmutableKmWithFlags

KotlinPoetMetadataPreview

Indicates that a given API is part of the experimental KotlinPoet metadata support. This exists because kotlinx-metadata is not a stable API, and will remain in place until it is.

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

annotation class KotlinPoetMetadataPreview

PropertyAccessorFlag

enum PropertyAccessorFlag : Enum<PropertyAccessorFlag>

Functions

readKotlinClassMetadata

Returns the KotlinClassMetadata this represents. In general you should only use this function when you don't know what the underlying KotlinClassMetadata subtype is, otherwise you should use one of the more direct functions like toImmutableKmClass.