ktor-utils/io.ktor.util/PublicAPICandidate

PublicAPICandidate

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.TYPEALIAS])

annotation class PublicAPICandidate(version: String)

API marked with this annotation is intended to become public in the future version. Usually it means that the API can't be public at the moment of development due to compatibility guarantees restrictions.

Marking a public declaration with this annotation makes no sense except for the case when it is also marked with InternalAPI.

Please note that the specified version and the fact of making something a candidate is not a guarantee, so the target version could be changed without any notice or even the promotion could be cancelled at all.

Constructors

PublicAPICandidate

fun PublicAPICandidate(version: String)

Properties

version

val version: String

in which the API is planned to be promoted