Skip to content

feat: sdk source readRemaining #1454

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat: sdk source readRemaining #1454

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3af04ea
feat: sdk source readRemaining
0marperez Oct 30, 2025
6958bfc
feedback
0marperez Oct 30, 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
1 change: 1 addition & 0 deletions runtime/runtime-core/api/runtime-core.api
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1097,6 +1097,7 @@ public abstract interface class aws/smithy/kotlin/runtime/io/SdkSource : java/io

public final class aws/smithy/kotlin/runtime/io/SdkSourceKt {
public static final fun readFully (Laws/smithy/kotlin/runtime/io/SdkSource;Laws/smithy/kotlin/runtime/io/SdkBuffer;J)V
public static final fun readRemaining (Laws/smithy/kotlin/runtime/io/SdkSource;Laws/smithy/kotlin/runtime/io/SdkBuffer;)J
public static final fun readToByteArray (Laws/smithy/kotlin/runtime/io/SdkSource;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public static final fun toSdkByteReadChannel (Laws/smithy/kotlin/runtime/io/SdkSource;Lkotlinx/coroutines/CoroutineScope;)Laws/smithy/kotlin/runtime/io/SdkByteReadChannel;
public static synthetic fun toSdkByteReadChannel$default (Laws/smithy/kotlin/runtime/io/SdkSource;Lkotlinx/coroutines/CoroutineScope;ILjava/lang/Object;)Laws/smithy/kotlin/runtime/io/SdkByteReadChannel;
Expand Down
20 changes: 20 additions & 0 deletions runtime/runtime-core/common/src/aws/smithy/kotlin/runtime/io/SdkSource.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,3 +110,23 @@ public fun SdkSource.readFully(sink: SdkBuffer, byteCount: Long) {
totalBytesRead += rc
}
}

/**
* **Caution** Reads the entire contents of the source into [sink].
* This function will read until the source is exhausted and no bytes remain
*
* @param sink the buffer that data read from the source will be appended to
*/
@InternalApi
public fun SdkSource.readRemaining(sink: SdkBuffer): Long {
var totalReadBytes: Long = 0
var readBytes: Long

do {
// ensure any errors are propagated by attempting to read at least once
readBytes = read(sink, Long.MAX_VALUE)
totalReadBytes += readBytes
} while (readBytes != -1L)

return totalReadBytes + 1L // Account for last -1 read
Copy link
Contributor

@lauzadis lauzadis Oct 31, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we should be counting the -1L. Can you write some unit tests for this function?

}
Loading