kord-common/dev.kord.common.annotation/KordUnsafe

KordUnsafe

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

annotation class KordUnsafe(source)

Marks a Kord-related API as potentially unsafe.

Kord marks targets as unsafe if it exposes functionality in a way that is more error-prone than alternatives and can lead to inconsistent state and fail silent or fail slow code.

The trade-off is usually increased performance by reducing cache hits and requests to the discord api.

Functionality that is annotated with KordUnsafe should suggest a safer alternative approach in its documentation.