Add UnsafeResultValueAccess annotation to Result class for safer value access

[hoc081098]

Issue #104

This pull request introduces a new @UnsafeResultValueAccess annotation to enforce safer access patterns for Result.value and Result.error in the kotlin-result library. Additionally, it updates the Kotlin conventions to opt into this annotation. Below are the key changes:

Enhancements to Result class safety:

• Added the @UnsafeResultValueAccess annotation to mark access to Result.value and Result.error as potentially unsafe unless the Result state is explicitly checked using Result.isOk or Result.isErr. This encourages safer usage patterns. (kotlin-result/src/commonMain/kotlin/com/github/michaelbull/result/Result.kt, [1] [2]

Kotlin conventions update:

• Updated the Kotlin conventions in kotlin-conventions.gradle.kts to opt into the @UnsafeResultValueAccess annotation, ensuring that projects using this configuration can leverage the new safety mechanism. (buildSrc/src/main/kotlin/kotlin-conventions.gradle.kts, buildSrc/src/main/kotlin/kotlin-conventions.gradle.ktsR62)

[michaelbull]

This is a great idea! Can you show me what it looks like in IntelliJ when you try to use the .value and .error fields without explicitly adding the annotation? Does it cause a compilation error or is it a warning?

[hoc081098]

This is a great idea! Can you show me what it looks like in IntelliJ when you try to use the .value and .error fields without explicitly adding the annotation? Does it cause a compilation error or is it a warning?

Yes 🙏

---

And when running :example:compileKotlin gradle task: