Promote Feeds to stable

README.md

@@ -158,9 +158,6 @@ the encoding/decoding process into its individual parts, such that the medium
 for which data is coming from or going to can be **anything**; `Feed`'s only 
 care about `Byte`(s) and `Char`(s)!
 
-`Feed`s are currently annotated with `ExperimentalEncodingApi` and require an 
-`OptIn` to use directly.
-
 ```kotlin
 // e.g. Concatenate multiple encodings
 val sb = StringBuilder()
@@ -169,7 +166,6 @@ val sb = StringBuilder()
 // encodings and preserve the counter.
 val out = LineBreakOutFeed(interval = 64) { char -> sb.append(char) }
 
-@OptIn(ExperimentalEncodingApi::class)
 Base64.Default.newEncoderFeed(out).use { feed ->
     "Hello World 1!".forEach { c -> feed.consume(c.code.toByte())  }
     feed.flush()
@@ -185,7 +181,6 @@ println(sb.toString())
 // e.g. Writing encoded data to a File in Java.
 // NOTE: try/catch omitted for this example.
 
-@OptIn(ExperimentalEncodingApi::class)
 file.outputStream().use { oStream ->
     Base64.Default.newEncoderFeed { encodedChar ->
         // As encoded data comes out of the feed,
@@ -237,7 +232,6 @@ if (size > Int.MAX_VALUE.toLong()) {
 
 val sb = StringBuilder(size.toInt())
 
-@OptIn(ExperimentalEncodingApi::class)
 file.inputStream().reader().use { iStreamReader ->
     Base64.Default.newDecoderFeed { decodedByte ->
         // As decoded data comes out of the feed,

library/base16/src/commonMain/kotlin/io/matthewnelson/encoding/base16/Base16.kt

@@ -59,7 +59,6 @@ import kotlin.jvm.JvmSynthetic
  * @see [Encoder.encodeToCharArray]
  * @see [Encoder.encodeToByteArray]
  * */
-@OptIn(ExperimentalEncodingApi::class)
 public class Base16(config: Base16.Config): EncoderDecoder<Base16.Config>(config) {
 
     /**

library/base32/src/commonMain/kotlin/io/matthewnelson/encoding/base32/Base32.kt

@@ -39,7 +39,6 @@ import kotlin.jvm.JvmSynthetic
  * @see [Encoder.encodeToCharArray]
  * @see [Encoder.encodeToByteArray]
  * */
-@OptIn(ExperimentalEncodingApi::class)
 public sealed class Base32<C: EncoderDecoder.Config>(config: C): EncoderDecoder<C>(config) {
 
     /**

library/base32/src/commonTest/kotlin/io/matthewnelson/encoding/base32/Base32CrockfordUnitTest.kt

@@ -20,12 +20,10 @@ package io.matthewnelson.encoding.base32
 import io.matthewnelson.encoding.core.Decoder.Companion.decodeToByteArray
 import io.matthewnelson.encoding.core.Decoder.Companion.decodeToByteArrayOrNull
 import io.matthewnelson.encoding.core.Encoder.Companion.encodeToString
-import io.matthewnelson.encoding.core.ExperimentalEncodingApi
 import io.matthewnelson.encoding.core.use
 import io.matthewnelson.encoding.test.BaseNEncodingTest
 import kotlin.test.*
 
-@OptIn(ExperimentalEncodingApi::class)
 class Base32CrockfordUnitTest: BaseNEncodingTest() {
 
     private var crockford: Base32.Crockford = Base32Crockford { checkSymbol(null) }

library/base64/src/commonMain/kotlin/io/matthewnelson/encoding/base64/Base64.kt

@@ -65,7 +65,6 @@ import kotlin.jvm.JvmSynthetic
  * @see [Encoder.encodeToCharArray]
  * @see [Encoder.encodeToByteArray]
  * */
-@OptIn(ExperimentalEncodingApi::class)
 public class Base64(config: Base64.Config): EncoderDecoder<Base64.Config>(config) {
 
     /**

library/core/src/commonMain/kotlin/io/matthewnelson/encoding/core/-Feed.kt

@@ -30,7 +30,6 @@ import io.matthewnelson.encoding.core.EncoderDecoder.Feed
  *  - Calling [Feed.close] if [block] **DID** throw an
  *    exception.
  * */
-@ExperimentalEncodingApi
 @OptIn(ExperimentalContracts::class)
 public inline fun <C: EncoderDecoder.Config, T: Feed<C>?, V> T.use(block: (T) -> V): V {
     contract {

library/core/src/commonMain/kotlin/io/matthewnelson/encoding/core/Decoder.kt

@@ -58,7 +58,6 @@ public sealed class Decoder<C: EncoderDecoder.Config>(public val config: C) {
      *
      * @see [Decoder.Feed]
      * */
-    @ExperimentalEncodingApi
     public fun newDecoderFeed(out: Decoder.OutFeed): Decoder<C>.Feed {
         // Reserved for future Decoder.OutFeed interception
         return newDecoderFeedProtected(out)
@@ -83,9 +82,7 @@ public sealed class Decoder<C: EncoderDecoder.Config>(public val config: C) {
      * @see [EncoderDecoder.Feed]
      * @see [EncoderDecoder.Feed.doFinal]
      * */
-    public abstract inner class Feed
-    @ExperimentalEncodingApi
-    constructor(): EncoderDecoder.Feed<C>(config) {
+    public abstract inner class Feed: EncoderDecoder.Feed<C>(config) {
         private var isClosed = false
         private var isPaddingSet = false
 
@@ -95,7 +92,6 @@ public sealed class Decoder<C: EncoderDecoder.Config>(public val config: C) {
          * @throws [EncodingException] if [isClosed] is true, or if
          *   there was an error decoding.
          * */
-        @ExperimentalEncodingApi
         @Throws(EncodingException::class)
         public fun consume(input: Char) {
             if (isClosed) throw closedException()
@@ -140,7 +136,6 @@ public sealed class Decoder<C: EncoderDecoder.Config>(public val config: C) {
          * @throws [EncodingException] if [isClosed] is true, or if
          *   there was an error decoding.
          * */
-        @ExperimentalEncodingApi
         @Throws(EncodingException::class)
         public final override fun flush() {
             if (isClosed) throw closedException()
@@ -154,7 +149,6 @@ public sealed class Decoder<C: EncoderDecoder.Config>(public val config: C) {
             }
         }
 
-        @ExperimentalEncodingApi
         public final override fun close() { isClosed = true }
         public final override fun isClosed(): Boolean = isClosed
         public final override fun toString(): String = "${this@Decoder}.Decoder.Feed@${hashCode()}"
@@ -185,7 +179,6 @@ public sealed class Decoder<C: EncoderDecoder.Config>(public val config: C) {
         @JvmStatic
         @Throws(EncodingException::class)
         public fun CharSequence.decodeToByteArray(decoder: Decoder<*>): ByteArray {
-            @OptIn(ExperimentalEncodingApi::class)
             return decoder.decode(DecoderInput(this)) { feed ->
                 forEach { c ->
                     feed.consume(c)
@@ -212,7 +205,6 @@ public sealed class Decoder<C: EncoderDecoder.Config>(public val config: C) {
         @JvmStatic
         @Throws(EncodingException::class)
         public fun CharArray.decodeToByteArray(decoder: Decoder<*>): ByteArray {
-            @OptIn(ExperimentalEncodingApi::class)
             return decoder.decode(DecoderInput(this)) { feed ->
                 forEach { c ->
                     feed.consume(c)
@@ -239,7 +231,6 @@ public sealed class Decoder<C: EncoderDecoder.Config>(public val config: C) {
         @JvmStatic
         @Throws(EncodingException::class)
         public fun ByteArray.decodeToByteArray(decoder: Decoder<*>): ByteArray {
-            @OptIn(ExperimentalEncodingApi::class)
             return decoder.decode(DecoderInput(this)) { feed ->
                 forEach { b ->
                     feed.consume(b.toInt().toChar())

library/core/src/commonMain/kotlin/io/matthewnelson/encoding/core/Encoder.kt

@@ -52,7 +52,6 @@ public sealed class Encoder<C: EncoderDecoder.Config>(config: C): Decoder<C>(con
      *
      * @see [Encoder.Feed]
      * */
-    @ExperimentalEncodingApi
     public fun newEncoderFeed(out: Encoder.OutFeed): Encoder<C>.Feed {
         return if (config.lineBreakInterval > 0 && out !is LineBreakOutFeed) {
             newEncoderFeedProtected(LineBreakOutFeed(config.lineBreakInterval, out))
@@ -80,17 +79,14 @@ public sealed class Encoder<C: EncoderDecoder.Config>(config: C): Decoder<C>(con
      * @see [EncoderDecoder.Feed]
      * @see [EncoderDecoder.Feed.doFinal]
      * */
-    public abstract inner class Feed
-    @ExperimentalEncodingApi
-    constructor(): EncoderDecoder.Feed<C>(config) {
+    public abstract inner class Feed: EncoderDecoder.Feed<C>(config) {
         private var isClosed = false
 
         /**
          * Updates the [Encoder.Feed] with a new byte to encode.
          *
          * @throws [EncodingException] if [isClosed] is true.
          * */
-        @ExperimentalEncodingApi
         @Throws(EncodingException::class)
         public fun consume(input: Byte) {
             if (isClosed) throw closedException()
@@ -112,7 +108,6 @@ public sealed class Encoder<C: EncoderDecoder.Config>(config: C): Decoder<C>(con
          * @see [EncoderDecoder.Feed.flush]
          * @throws [EncodingException] if [isClosed] is true.
          * */
-        @ExperimentalEncodingApi
         @Throws(EncodingException::class)
         public final override fun flush() {
             if (isClosed) throw closedException()
@@ -127,7 +122,6 @@ public sealed class Encoder<C: EncoderDecoder.Config>(config: C): Decoder<C>(con
             }
         }
 
-        @ExperimentalEncodingApi
         public final override fun close() { isClosed = true }
         public final override fun isClosed(): Boolean = isClosed
         public final override fun toString(): String = "${this@Encoder}.Encoder.Feed@${hashCode()}"

library/core/src/commonMain/kotlin/io/matthewnelson/encoding/core/EncoderDecoder.kt

@@ -33,9 +33,7 @@ import kotlin.jvm.JvmStatic
  * @see [Encoder]
  * @see [Decoder]
  * */
-public abstract class EncoderDecoder<C: EncoderDecoder.Config>
-@ExperimentalEncodingApi
-constructor(config: C): Encoder<C>(config) {
+public abstract class EncoderDecoder<C: EncoderDecoder.Config>(config: C): Encoder<C>(config) {
 
     /**
      * Base configuration for an [EncoderDecoder]. More options
@@ -54,9 +52,7 @@ constructor(config: C): Encoder<C>(config) {
      *   used". If the encoding specification does not use padding,
      *   pass `null`.
      * */
-    public abstract class Config
-    @ExperimentalEncodingApi
-    constructor(
+    public abstract class Config(
         @JvmField
         public val isLenient: Boolean?,
         lineBreakInterval: Byte,
@@ -417,7 +413,6 @@ constructor(config: C): Encoder<C>(config) {
          * @throws [EncodingException] if [isClosed] is true, or
          *   there was an error encoding/decoding.
          * */
-        @ExperimentalEncodingApi
         @Throws(EncodingException::class)
         public abstract fun flush()
 
@@ -436,7 +431,6 @@ constructor(config: C): Encoder<C>(config) {
          * @throws [EncodingException] if [isClosed] is true, or
          *   there was an error encoding/decoding.
          * */
-        @ExperimentalEncodingApi
         @Throws(EncodingException::class)
         public fun doFinal() {
             if (isClosed()) throw closedException()
@@ -462,7 +456,6 @@ constructor(config: C): Encoder<C>(config) {
          *
          * @see [use]
          * */
-        @ExperimentalEncodingApi
         public abstract fun close()
 
         public abstract fun isClosed(): Boolean

library/core/src/commonMain/kotlin/io/matthewnelson/encoding/core/internal/-EncoderDecoder.kt

@@ -26,7 +26,7 @@ import kotlin.contracts.contract
 
 @Suppress("NOTHING_TO_INLINE")
 @Throws(EncodingException::class)
-@OptIn(ExperimentalEncodingApi::class, ExperimentalContracts::class)
+@OptIn(ExperimentalContracts::class)
 internal inline fun <C: Config> Decoder<C>.decode(
     input: DecoderInput,
     action: (feed: Decoder<*>.Feed) -> Unit
@@ -82,7 +82,6 @@ internal inline fun <T: Any> Encoder<*>.encodeOutSizeOrFail(
 }
 
 @Suppress("NOTHING_TO_INLINE")
-@OptIn(ExperimentalEncodingApi::class)
 internal inline fun <C: Config> Encoder<C>.encode(
     data: ByteArray,
     out: Encoder.OutFeed,

library/core/src/commonTest/kotlin/io/matthewnelson/encoding/core/EncoderDecoderFeedUnitTest.kt

@@ -20,7 +20,6 @@ import io.matthewnelson.encoding.core.helpers.TestEncoderDecoder
 import io.matthewnelson.encoding.core.util.LineBreakOutFeed
 import kotlin.test.*
 
-@OptIn(ExperimentalEncodingApi::class)
 class EncoderDecoderFeedUnitTest {
 
     @Test

library/core/src/commonTest/kotlin/io/matthewnelson/encoding/core/helpers/TestConfig.kt

@@ -16,10 +16,8 @@
 package io.matthewnelson.encoding.core.helpers
 
 import io.matthewnelson.encoding.core.EncoderDecoder
-import io.matthewnelson.encoding.core.ExperimentalEncodingApi
 import io.matthewnelson.encoding.core.util.DecoderInput
 
-@OptIn(ExperimentalEncodingApi::class)
 class TestConfig(
     isLenient: Boolean? = false,
     lineBreakInterval: Byte = 0,

library/core/src/commonTest/kotlin/io/matthewnelson/encoding/core/helpers/TestEncoderDecoder.kt

@@ -17,7 +17,6 @@ package io.matthewnelson.encoding.core.helpers
 
 import io.matthewnelson.encoding.core.*
 
-@OptIn(ExperimentalEncodingApi::class)
 class TestEncoderDecoder(
     config: TestConfig,
     private val encoderDoFinal: ((Encoder<TestConfig>.Feed) -> Unit)? = null,