runtime-core/aws.smithy.kotlin.runtime.content/ByteStream

ByteStream

sealed class ByteStream

Represents an abstract read-only stream of bytes

Inheritors

Types

abstract class Buffer : ByteStream

Variant of a ByteStream with payload represented as an in-memory byte buffer.

abstract class ChannelStream : ByteStream

Variant of a ByteStream with a streaming payload read from an SdkByteReadChannel

object Companion

abstract class SourceStream : ByteStream

Variant of a ByteStream with a streaming payload read from an SdkSource

Properties

open val contentLength: Long? = null

The content length if known

open val isOneShot: Boolean = true

Flag indicating if the body can only be consumed once. If false the underlying stream must be capable of being replayed.

Inherited functions

appendToOutputStream

suspend fun ByteStream.appendToOutputStream(outputStream: OutputStream): Long

Writes this stream to the given OutputStream. This method does not flush or close the given OutputStream.

fun ByteStream.cancel()

suspend fun ByteStream.decodeToString(): String

suspend fun ByteStream.toByteArray(): ByteArray

Consume the ByteStream and pull the entire contents into memory as a ByteArray. Only do this if you are sure the contents fit in-memory as this will read the entire contents of a streaming variant.

fun ByteStream.toFlow(bufferSize: Long = 8192): Flow<ByteArray>

Return a Flow that consumes the underlying ByteStream when collected.

fun ByteStream.toInputStream(): InputStream

Create a blocking InputStream that reads from the underlying ByteStream.

suspend fun ByteStream.writeToFile(file: File): Long

Write the contents of this ByteStream to file and close it

suspend fun ByteStream.writeToFile(path: Path): Long

Write the contents of this ByteStream to file at the given path

writeToOutputStream

suspend fun ByteStream.writeToOutputStream(outputStream: OutputStream): Long

Writes this stream to the given OutputStream, then closes it.