Make asMap() experimental with a new ExperimentalHeadersApi annotation

joffrey-bion · Sep 18, 2024 · d2fdcc2 · d2fdcc2
1 parent 1f14b1f
commit d2fdcc2
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/krossbow-stomp-core/build.gradle.kts b/krossbow-stomp-core/build.gradle.kts
@@ -16,6 +16,7 @@ kotlin {
                 freeCompilerArgs.add("-Xexpect-actual-classes") // for charsets
             }
             languageSettings.optIn("org.hildan.krossbow.io.InternalKrossbowIoApi")
+            languageSettings.optIn("org.hildan.krossbow.stomp.headers.ExperimentalHeadersApi")
         }
         val commonMain by getting {
             dependencies {

diff --git a/krossbow-stomp-core/src/commonMain/kotlin/org/hildan/krossbow/stomp/headers/StompHeaders.kt b/krossbow-stomp-core/src/commonMain/kotlin/org/hildan/krossbow/stomp/headers/StompHeaders.kt
@@ -4,6 +4,14 @@ import org.hildan.krossbow.stomp.headers.HeaderNames.CONTENT_LENGTH
 import org.hildan.krossbow.stomp.headers.HeaderNames.CONTENT_TYPE
 import org.hildan.krossbow.stomp.headers.HeaderNames.RECEIPT
 
+/**
+ * Declarations annotated with this annotation are unstable and may be changed or removed at any time without a major
+ * version bump.
+ */
+@RequiresOptIn("This API is experimental and may be changed or removed in the future without notice.")
+@Target(AnnotationTarget.CLASS, AnnotationTarget.FUNCTION)
+annotation class ExperimentalHeadersApi
+
 /**
  * The headers of a STOMP frame.
  */
@@ -50,6 +58,7 @@ sealed interface StompHeaders {
     /**
      * Returns a [Map] view of these headers.
      */
+    @ExperimentalHeadersApi
     fun asMap(): Map<String, String>
 }