Skip to content

Add Decoder.{decodeBuffered/decodeBufferedAsync} extension functions #210

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
05nelsonm merged 9 commits into from
Dec 9, 2025
Merged

Add Decoder.{decodeBuffered/decodeBufferedAsync} extension functions #210

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
3752ee5
Add version info to deprecation documentation
05nelsonm Dec 7, 2025
4dad1f9
Move parameter linBreakInterval to above secondary constructor (for b…
05nelsonm Dec 7, 2025
373031a
Add TODO items
05nelsonm Dec 8, 2025
9f51eb6
WIP: Stub in decodeBuffered API
05nelsonm Dec 8, 2025
a468568
Fix UTF8.Config.maxDecodeEmit calculation
05nelsonm Dec 8, 2025
1c2d21c
Rename decodeBuffered suspend functions to decodeBufferedAsync
05nelsonm Dec 8, 2025
0023af2
Add documentation
05nelsonm Dec 8, 2025
b32bd2a
Mitigate unnecessary decode array copying by moving logic to higher l…
05nelsonm Dec 8, 2025
c690fd1
Add ability to pass in an already allocated buffer to decodeBuffered/…
05nelsonm Dec 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ Configurable, streamable, efficient and extensible encoding/decoding for Kotlin
### Get Started

<!-- TAG_VERSION -->
<!-- TODO: Add utf8 -->

```kotlin
// build.gradle.kts
Expand All @@ -54,6 +55,7 @@ dependencies {
```

<!-- TAG_VERSION -->
<!-- TODO: Add utf8 -->
Alternatively, you can use the BOM.

```kotlin
Expand Down
10 changes: 5 additions & 5 deletions library/base16/src/commonMain/kotlin/io/matthewnelson/component/encoding/base16/Base16.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import io.matthewnelson.encoding.core.Encoder.Companion.encodeToCharArray
import io.matthewnelson.encoding.core.Encoder.Companion.encodeToString

/**
* DEPRECATED
* DEPRECATED since `1.2.0`
* @suppress
* */
@Deprecated(
Expand All @@ -43,7 +43,7 @@ public inline fun String.decodeBase16ToArray(): ByteArray? {
}

/**
* DEPRECATED
* DEPRECATED since `1.2.0`
* @suppress
* */
@Deprecated(
Expand All @@ -62,7 +62,7 @@ public fun CharArray.decodeBase16ToArray(): ByteArray? {
}

/**
* DEPRECATED
* DEPRECATED since `1.2.0`
* @suppress
* */
@Deprecated(
Expand All @@ -81,7 +81,7 @@ public inline fun ByteArray.encodeBase16(): String {
}

/**
* DEPRECATED
* DEPRECATED since `1.2.0`
* @suppress
* */
@Deprecated(
Expand All @@ -100,7 +100,7 @@ public inline fun ByteArray.encodeBase16ToCharArray(): CharArray {
}

/**
* DEPRECATED
* DEPRECATED since `1.2.0`
* @suppress
* */
@Deprecated(
Expand Down
4 changes: 2 additions & 2 deletions library/base16/src/commonMain/kotlin/io/matthewnelson/encoding/base16/Base16.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ public class Base16: EncoderDecoder<Base16.Config> {
}

/**
* DEPRECATED
* DEPRECATED since `2.6.0`
* @suppress
* */
@JvmField
Expand Down Expand Up @@ -385,7 +385,7 @@ public class Base16: EncoderDecoder<Base16.Config> {
}

/**
* DEPRECATED
* DEPRECATED since `2.6.0`
* @suppress
* */
@Deprecated(
Expand Down
10 changes: 5 additions & 5 deletions library/base16/src/commonMain/kotlin/io/matthewnelson/encoding/base16/Builders.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import kotlin.jvm.JvmOverloads
import kotlin.jvm.JvmSynthetic

/**
* DEPRECATED
* DEPRECATED since `2.6.0`
* @suppress
* @see [Base16.Builder]
* @see [Base16.Companion.Builder]
Expand All @@ -38,7 +38,7 @@ public fun Base16(
): Base16 = Base16ConfigBuilder(config).apply(block).buildCompat()

/**
* DEPRECATED
* DEPRECATED since `2.6.0`
* @suppress
* @see [Base16.Builder]
* @see [Base16.Companion.Builder]
Expand All @@ -52,7 +52,7 @@ public fun Base16(
): Base16 = Base16(config = null, block)

/**
* DEPRECATED
* DEPRECATED since `2.6.0`
* @suppress
* @see [Base16.Builder]
* @see [Base16.Companion.Builder]
Expand All @@ -67,7 +67,7 @@ public fun Base16(
): Base16 = Base16.Builder { if (strict) strictSpec() }

/**
* DEPRECATED
* DEPRECATED since `2.6.0`
* @suppress
* @see [Base16.Builder]
* @see [Base16.Companion.Builder]
Expand Down Expand Up @@ -129,7 +129,7 @@ public class Base16ConfigBuilder {
.build()

/**
* DEPRECATED
* DEPRECATED since `2.3.1`
* @suppress
* */
@JvmField
Expand Down
32 changes: 16 additions & 16 deletions library/base32/src/commonMain/kotlin/io/matthewnelson/component/encoding/base32/Base32.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import io.matthewnelson.encoding.core.Encoder.Companion.encodeToString
import kotlin.jvm.JvmOverloads

/**
* DEPRECATED
* DEPRECATED since `1.2.0`
* @suppress
* */
@Deprecated(
Expand Down Expand Up @@ -71,7 +71,7 @@ public sealed class Base32 {
}

/**
* DEPRECATED
* DEPRECATED since `1.2.0`
* @suppress
* */
@Deprecated(
Expand All @@ -91,7 +91,7 @@ public inline fun String.decodeBase32ToArray(base32: Base32.Default = Base32.Def
}

/**
* DEPRECATED
* DEPRECATED since `1.2.0`
* @suppress
* */
@Deprecated(
Expand All @@ -110,7 +110,7 @@ public inline fun String.decodeBase32ToArray(base32: Base32.Hex): ByteArray? {
}

/**
* DEPRECATED
* DEPRECATED since `1.2.0`
* @suppress
* */
@Deprecated(
Expand All @@ -129,7 +129,7 @@ public inline fun String.decodeBase32ToArray(base32: Base32.Crockford): ByteArra
}

/**
* DEPRECATED
* DEPRECATED since `1.2.0`
* @suppress
* */
@Deprecated(
Expand All @@ -149,7 +149,7 @@ public fun CharArray.decodeBase32ToArray(base32: Base32.Default = Base32.Default
}

/**
* DEPRECATED
* DEPRECATED since `1.2.0`
* @suppress
* */
@Deprecated(
Expand All @@ -168,7 +168,7 @@ public fun CharArray.decodeBase32ToArray(base32: Base32.Hex): ByteArray? {
}

/**
* DEPRECATED
* DEPRECATED since `1.2.0`
* @suppress
* */
@Deprecated(
Expand All @@ -187,7 +187,7 @@ public fun CharArray.decodeBase32ToArray(base32: Base32.Crockford): ByteArray? {
}

/**
* DEPRECATED
* DEPRECATED since `1.2.0`
* @suppress
* */
@Deprecated(
Expand All @@ -207,7 +207,7 @@ public inline fun ByteArray.encodeBase32(base32: Base32.Default = Base32.Default
}

/**
* DEPRECATED
* DEPRECATED since `1.2.0`
* @suppress
* */
@Deprecated(
Expand All @@ -226,7 +226,7 @@ public inline fun ByteArray.encodeBase32(base32: Base32.Hex): String {
}

/**
* DEPRECATED
* DEPRECATED since `1.2.0`
* @suppress
* */
@Deprecated(
Expand All @@ -245,7 +245,7 @@ public inline fun ByteArray.encodeBase32(base32: Base32.Crockford): String {
}

/**
* DEPRECATED
* DEPRECATED since `1.2.0`
* @suppress
* */
@Deprecated(
Expand All @@ -265,7 +265,7 @@ public inline fun ByteArray.encodeBase32ToCharArray(base32: Base32.Default = Bas
}

/**
* DEPRECATED
* DEPRECATED since `1.2.0`
* @suppress
* */
@Deprecated(
Expand All @@ -284,7 +284,7 @@ public inline fun ByteArray.encodeBase32ToCharArray(base32: Base32.Hex): CharArr
}

/**
* DEPRECATED
* DEPRECATED since `1.2.0`
* @suppress
* */
@Deprecated(
Expand All @@ -303,7 +303,7 @@ public inline fun ByteArray.encodeBase32ToCharArray(base32: Base32.Crockford): C
}

/**
* DEPRECATED
* DEPRECATED since `1.2.0`
* @suppress
* */
@Deprecated(
Expand All @@ -323,7 +323,7 @@ public fun ByteArray.encodeBase32ToByteArray(base32: Base32.Default = Base32.Def
}

/**
* DEPRECATED
* DEPRECATED since `1.2.0`
* @suppress
* */
@Deprecated(
Expand All @@ -342,7 +342,7 @@ public fun ByteArray.encodeBase32ToByteArray(base32: Base32.Hex): ByteArray {
}

/**
* DEPRECATED
* DEPRECATED since `1.2.0`
* @suppress
* */
@Deprecated(
Expand Down
12 changes: 6 additions & 6 deletions library/base32/src/commonMain/kotlin/io/matthewnelson/encoding/base32/Base32.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,7 @@ public sealed class Base32<C: EncoderDecoder.Config>(config: C): EncoderDecoder<
}

/**
* DEPRECATED
* DEPRECATED since `2.6.0`
* @suppress
* */
@JvmField
Expand Down Expand Up @@ -435,7 +435,7 @@ public sealed class Base32<C: EncoderDecoder.Config>(config: C): EncoderDecoder<
}

/**
* DEPRECATED
* DEPRECATED since `2.6.0`
* @suppress
* */
@Deprecated(
Expand Down Expand Up @@ -661,7 +661,7 @@ public sealed class Base32<C: EncoderDecoder.Config>(config: C): EncoderDecoder<
}

/**
* DEPRECATED
* DEPRECATED since `2.6.0`
* @suppress
* */
@JvmField
Expand Down Expand Up @@ -760,7 +760,7 @@ public sealed class Base32<C: EncoderDecoder.Config>(config: C): EncoderDecoder<
}

/**
* DEPRECATED
* DEPRECATED since `2.6.0`
* @suppress
* */
@Deprecated(
Expand Down Expand Up @@ -986,7 +986,7 @@ public sealed class Base32<C: EncoderDecoder.Config>(config: C): EncoderDecoder<
}

/**
* DEPRECATED
* DEPRECATED since `2.6.0`
* @suppress
* */
@JvmField
Expand Down Expand Up @@ -1085,7 +1085,7 @@ public sealed class Base32<C: EncoderDecoder.Config>(config: C): EncoderDecoder<
}

/**
* DEPRECATED
* DEPRECATED since `2.6.0`
* @suppress
* */
@Deprecated(
Expand Down
Loading