kotlin-stdlib/kotlin.io.path/ExperimentalPathApi

ExperimentalPathApi

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.LOCAL_VARIABLE, AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.TYPEALIAS])
annotation class ExperimentalPathApi(source)

This annotation marks the extensions and top-level functions for working with java.nio.file.Path considered experimental.

Beware using the annotated API especially if you're developing a library, since your library might become binary incompatible with the future versions of the standard library.

Any usage of a declaration annotated with @ExperimentalPathApi must be accepted either by annotating that usage with the OptIn annotation, e.g. @OptIn(ExperimentalPathApi::class), or by using the compiler argument -opt-in=kotlin.io.path.ExperimentalPathApi.

Since Kotlin

1.4