Skip to content

Implement partial array encoding #233

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 4 commits into from
Dec 13, 2025
Merged

Implement partial array encoding #233

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5f54f3f
Add bounds checking functions
05nelsonm Dec 13, 2025
cd314b7
WIP: Add encoding functions which take offset/len arguments
05nelsonm Dec 13, 2025
fdb2b57
Add unit tests
05nelsonm Dec 13, 2025
38004b2
Fix documentation
05nelsonm Dec 13, 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
16 changes: 16 additions & 0 deletions library/core/api/core.api
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,29 +77,45 @@ public final class io/matthewnelson/encoding/core/Decoder$OutFeed$Companion {
public abstract class io/matthewnelson/encoding/core/Encoder : io/matthewnelson/encoding/core/Decoder {
public static final field Companion Lio/matthewnelson/encoding/core/Encoder$Companion;
public synthetic fun <init> (Lio/matthewnelson/encoding/core/EncoderDecoder$Config;Lkotlin/jvm/internal/DefaultConstructorMarker;)V
public static final fun encodeBuffered ([BLio/matthewnelson/encoding/core/Encoder;ZIIILkotlin/jvm/functions/Function3;)J
public static final fun encodeBuffered ([BLio/matthewnelson/encoding/core/Encoder;ZIILkotlin/jvm/functions/Function3;)J
public static final fun encodeBuffered ([BLio/matthewnelson/encoding/core/Encoder;ZII[CLkotlin/jvm/functions/Function3;)J
public static final fun encodeBuffered ([BLio/matthewnelson/encoding/core/Encoder;ZILkotlin/jvm/functions/Function3;)J
public static final fun encodeBuffered ([BLio/matthewnelson/encoding/core/Encoder;ZLkotlin/jvm/functions/Function3;)J
public static final fun encodeBuffered ([BLio/matthewnelson/encoding/core/Encoder;Z[CLkotlin/jvm/functions/Function3;)J
public static final fun encodeBufferedAsync ([BLio/matthewnelson/encoding/core/Encoder;ZIIILkotlin/jvm/functions/Function4;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public static final fun encodeBufferedAsync ([BLio/matthewnelson/encoding/core/Encoder;ZIILkotlin/jvm/functions/Function4;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public static final fun encodeBufferedAsync ([BLio/matthewnelson/encoding/core/Encoder;ZII[CLkotlin/jvm/functions/Function4;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public static final fun encodeBufferedAsync ([BLio/matthewnelson/encoding/core/Encoder;ZILkotlin/jvm/functions/Function4;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public static final fun encodeBufferedAsync ([BLio/matthewnelson/encoding/core/Encoder;ZLkotlin/jvm/functions/Function4;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public static final fun encodeBufferedAsync ([BLio/matthewnelson/encoding/core/Encoder;Z[CLkotlin/jvm/functions/Function4;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public static final fun encodeToByteArray ([BLio/matthewnelson/encoding/core/Encoder;)[B
public static final fun encodeToCharArray ([BLio/matthewnelson/encoding/core/Encoder;)[C
public static final fun encodeToCharArray ([BLio/matthewnelson/encoding/core/Encoder;II)[C
public static final fun encodeToString ([BLio/matthewnelson/encoding/core/Encoder;)Ljava/lang/String;
public static final fun encodeToString ([BLio/matthewnelson/encoding/core/Encoder;II)Ljava/lang/String;
public final fun newEncoderFeed (Lio/matthewnelson/encoding/core/Encoder$OutFeed;)Lio/matthewnelson/encoding/core/Encoder$Feed;
protected abstract fun newEncoderFeedProtected (Lio/matthewnelson/encoding/core/Encoder$OutFeed;)Lio/matthewnelson/encoding/core/Encoder$Feed;
}

public final class io/matthewnelson/encoding/core/Encoder$Companion {
public final fun encodeBuffered ([BLio/matthewnelson/encoding/core/Encoder;ZIIILkotlin/jvm/functions/Function3;)J
public final fun encodeBuffered ([BLio/matthewnelson/encoding/core/Encoder;ZIILkotlin/jvm/functions/Function3;)J
public final fun encodeBuffered ([BLio/matthewnelson/encoding/core/Encoder;ZII[CLkotlin/jvm/functions/Function3;)J
public final fun encodeBuffered ([BLio/matthewnelson/encoding/core/Encoder;ZILkotlin/jvm/functions/Function3;)J
public final fun encodeBuffered ([BLio/matthewnelson/encoding/core/Encoder;ZLkotlin/jvm/functions/Function3;)J
public final fun encodeBuffered ([BLio/matthewnelson/encoding/core/Encoder;Z[CLkotlin/jvm/functions/Function3;)J
public final fun encodeBufferedAsync ([BLio/matthewnelson/encoding/core/Encoder;ZIIILkotlin/jvm/functions/Function4;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public final fun encodeBufferedAsync ([BLio/matthewnelson/encoding/core/Encoder;ZIILkotlin/jvm/functions/Function4;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public final fun encodeBufferedAsync ([BLio/matthewnelson/encoding/core/Encoder;ZII[CLkotlin/jvm/functions/Function4;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public final fun encodeBufferedAsync ([BLio/matthewnelson/encoding/core/Encoder;ZILkotlin/jvm/functions/Function4;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public final fun encodeBufferedAsync ([BLio/matthewnelson/encoding/core/Encoder;ZLkotlin/jvm/functions/Function4;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public final fun encodeBufferedAsync ([BLio/matthewnelson/encoding/core/Encoder;Z[CLkotlin/jvm/functions/Function4;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public final fun encodeToByteArray ([BLio/matthewnelson/encoding/core/Encoder;)[B
public final fun encodeToCharArray ([BLio/matthewnelson/encoding/core/Encoder;)[C
public final fun encodeToCharArray ([BLio/matthewnelson/encoding/core/Encoder;II)[C
public final fun encodeToString ([BLio/matthewnelson/encoding/core/Encoder;)Ljava/lang/String;
public final fun encodeToString ([BLio/matthewnelson/encoding/core/Encoder;II)Ljava/lang/String;
}

public abstract class io/matthewnelson/encoding/core/Encoder$Feed : io/matthewnelson/encoding/core/EncoderDecoder$Feed {
Expand Down
8 changes: 8 additions & 0 deletions library/core/api/core.klib.api
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,12 +276,20 @@ sealed class <#A: io.matthewnelson.encoding.core/EncoderDecoder.Config> io.matth
final object Companion { // io.matthewnelson.encoding.core/Encoder.Companion|null[0]
final fun (kotlin/ByteArray).encodeBuffered(io.matthewnelson.encoding.core/Encoder<*>, kotlin/Boolean, kotlin/CharArray, kotlin/Function3<kotlin/CharArray, kotlin/Int, kotlin/Int, kotlin/Unit>): kotlin/Long // io.matthewnelson.encoding.core/Encoder.Companion.encodeBuffered|[email protected](io.matthewnelson.encoding.core.Encoder<*>;kotlin.Boolean;kotlin.CharArray;kotlin.Function3<kotlin.CharArray,kotlin.Int,kotlin.Int,kotlin.Unit>){}[0]
final fun (kotlin/ByteArray).encodeBuffered(io.matthewnelson.encoding.core/Encoder<*>, kotlin/Boolean, kotlin/Int, kotlin/Function3<kotlin/CharArray, kotlin/Int, kotlin/Int, kotlin/Unit>): kotlin/Long // io.matthewnelson.encoding.core/Encoder.Companion.encodeBuffered|[email protected](io.matthewnelson.encoding.core.Encoder<*>;kotlin.Boolean;kotlin.Int;kotlin.Function3<kotlin.CharArray,kotlin.Int,kotlin.Int,kotlin.Unit>){}[0]
final fun (kotlin/ByteArray).encodeBuffered(io.matthewnelson.encoding.core/Encoder<*>, kotlin/Boolean, kotlin/Int, kotlin/Int, kotlin/CharArray, kotlin/Function3<kotlin/CharArray, kotlin/Int, kotlin/Int, kotlin/Unit>): kotlin/Long // io.matthewnelson.encoding.core/Encoder.Companion.encodeBuffered|[email protected](io.matthewnelson.encoding.core.Encoder<*>;kotlin.Boolean;kotlin.Int;kotlin.Int;kotlin.CharArray;kotlin.Function3<kotlin.CharArray,kotlin.Int,kotlin.Int,kotlin.Unit>){}[0]
final fun (kotlin/ByteArray).encodeBuffered(io.matthewnelson.encoding.core/Encoder<*>, kotlin/Boolean, kotlin/Int, kotlin/Int, kotlin/Int, kotlin/Function3<kotlin/CharArray, kotlin/Int, kotlin/Int, kotlin/Unit>): kotlin/Long // io.matthewnelson.encoding.core/Encoder.Companion.encodeBuffered|[email protected](io.matthewnelson.encoding.core.Encoder<*>;kotlin.Boolean;kotlin.Int;kotlin.Int;kotlin.Int;kotlin.Function3<kotlin.CharArray,kotlin.Int,kotlin.Int,kotlin.Unit>){}[0]
final fun (kotlin/ByteArray).encodeToByteArray(io.matthewnelson.encoding.core/Encoder<*>): kotlin/ByteArray // io.matthewnelson.encoding.core/Encoder.Companion.encodeToByteArray|[email protected](io.matthewnelson.encoding.core.Encoder<*>){}[0]
final fun (kotlin/ByteArray).encodeToCharArray(io.matthewnelson.encoding.core/Encoder<*>): kotlin/CharArray // io.matthewnelson.encoding.core/Encoder.Companion.encodeToCharArray|[email protected](io.matthewnelson.encoding.core.Encoder<*>){}[0]
final fun (kotlin/ByteArray).encodeToCharArray(io.matthewnelson.encoding.core/Encoder<*>, kotlin/Int, kotlin/Int): kotlin/CharArray // io.matthewnelson.encoding.core/Encoder.Companion.encodeToCharArray|[email protected](io.matthewnelson.encoding.core.Encoder<*>;kotlin.Int;kotlin.Int){}[0]
final fun (kotlin/ByteArray).encodeToString(io.matthewnelson.encoding.core/Encoder<*>): kotlin/String // io.matthewnelson.encoding.core/Encoder.Companion.encodeToString|[email protected](io.matthewnelson.encoding.core.Encoder<*>){}[0]
final fun (kotlin/ByteArray).encodeToString(io.matthewnelson.encoding.core/Encoder<*>, kotlin/Int, kotlin/Int): kotlin/String // io.matthewnelson.encoding.core/Encoder.Companion.encodeToString|[email protected](io.matthewnelson.encoding.core.Encoder<*>;kotlin.Int;kotlin.Int){}[0]
final inline fun (kotlin/ByteArray).encodeBuffered(io.matthewnelson.encoding.core/Encoder<*>, kotlin/Boolean, kotlin/Int, kotlin/Int, noinline kotlin/Function3<kotlin/CharArray, kotlin/Int, kotlin/Int, kotlin/Unit>): kotlin/Long // io.matthewnelson.encoding.core/Encoder.Companion.encodeBuffered|[email protected](io.matthewnelson.encoding.core.Encoder<*>;kotlin.Boolean;kotlin.Int;kotlin.Int;kotlin.Function3<kotlin.CharArray,kotlin.Int,kotlin.Int,kotlin.Unit>){}[0]
final inline fun (kotlin/ByteArray).encodeBuffered(io.matthewnelson.encoding.core/Encoder<*>, kotlin/Boolean, noinline kotlin/Function3<kotlin/CharArray, kotlin/Int, kotlin/Int, kotlin/Unit>): kotlin/Long // io.matthewnelson.encoding.core/Encoder.Companion.encodeBuffered|[email protected](io.matthewnelson.encoding.core.Encoder<*>;kotlin.Boolean;kotlin.Function3<kotlin.CharArray,kotlin.Int,kotlin.Int,kotlin.Unit>){}[0]
final suspend fun (kotlin/ByteArray).encodeBufferedAsync(io.matthewnelson.encoding.core/Encoder<*>, kotlin/Boolean, kotlin/CharArray, kotlin.coroutines/SuspendFunction3<kotlin/CharArray, kotlin/Int, kotlin/Int, kotlin/Unit>): kotlin/Long // io.matthewnelson.encoding.core/Encoder.Companion.encodeBufferedAsync|[email protected](io.matthewnelson.encoding.core.Encoder<*>;kotlin.Boolean;kotlin.CharArray;kotlin.coroutines.SuspendFunction3<kotlin.CharArray,kotlin.Int,kotlin.Int,kotlin.Unit>){}[0]
final suspend fun (kotlin/ByteArray).encodeBufferedAsync(io.matthewnelson.encoding.core/Encoder<*>, kotlin/Boolean, kotlin/Int, kotlin.coroutines/SuspendFunction3<kotlin/CharArray, kotlin/Int, kotlin/Int, kotlin/Unit>): kotlin/Long // io.matthewnelson.encoding.core/Encoder.Companion.encodeBufferedAsync|[email protected](io.matthewnelson.encoding.core.Encoder<*>;kotlin.Boolean;kotlin.Int;kotlin.coroutines.SuspendFunction3<kotlin.CharArray,kotlin.Int,kotlin.Int,kotlin.Unit>){}[0]
final suspend fun (kotlin/ByteArray).encodeBufferedAsync(io.matthewnelson.encoding.core/Encoder<*>, kotlin/Boolean, kotlin/Int, kotlin/Int, kotlin/CharArray, kotlin.coroutines/SuspendFunction3<kotlin/CharArray, kotlin/Int, kotlin/Int, kotlin/Unit>): kotlin/Long // io.matthewnelson.encoding.core/Encoder.Companion.encodeBufferedAsync|[email protected](io.matthewnelson.encoding.core.Encoder<*>;kotlin.Boolean;kotlin.Int;kotlin.Int;kotlin.CharArray;kotlin.coroutines.SuspendFunction3<kotlin.CharArray,kotlin.Int,kotlin.Int,kotlin.Unit>){}[0]
final suspend fun (kotlin/ByteArray).encodeBufferedAsync(io.matthewnelson.encoding.core/Encoder<*>, kotlin/Boolean, kotlin/Int, kotlin/Int, kotlin/Int, kotlin.coroutines/SuspendFunction3<kotlin/CharArray, kotlin/Int, kotlin/Int, kotlin/Unit>): kotlin/Long // io.matthewnelson.encoding.core/Encoder.Companion.encodeBufferedAsync|[email protected](io.matthewnelson.encoding.core.Encoder<*>;kotlin.Boolean;kotlin.Int;kotlin.Int;kotlin.Int;kotlin.coroutines.SuspendFunction3<kotlin.CharArray,kotlin.Int,kotlin.Int,kotlin.Unit>){}[0]
final suspend inline fun (kotlin/ByteArray).encodeBufferedAsync(io.matthewnelson.encoding.core/Encoder<*>, kotlin/Boolean, kotlin/Int, kotlin/Int, noinline kotlin.coroutines/SuspendFunction3<kotlin/CharArray, kotlin/Int, kotlin/Int, kotlin/Unit>): kotlin/Long // io.matthewnelson.encoding.core/Encoder.Companion.encodeBufferedAsync|[email protected](io.matthewnelson.encoding.core.Encoder<*>;kotlin.Boolean;kotlin.Int;kotlin.Int;kotlin.coroutines.SuspendFunction3<kotlin.CharArray,kotlin.Int,kotlin.Int,kotlin.Unit>){}[0]
final suspend inline fun (kotlin/ByteArray).encodeBufferedAsync(io.matthewnelson.encoding.core/Encoder<*>, kotlin/Boolean, noinline kotlin.coroutines/SuspendFunction3<kotlin/CharArray, kotlin/Int, kotlin/Int, kotlin/Unit>): kotlin/Long // io.matthewnelson.encoding.core/Encoder.Companion.encodeBufferedAsync|[email protected](io.matthewnelson.encoding.core.Encoder<*>;kotlin.Boolean;kotlin.coroutines.SuspendFunction3<kotlin.CharArray,kotlin.Int,kotlin.Int,kotlin.Unit>){}[0]
}
}
Expand Down
Loading