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

Package-level declarations

Types

expect class BigDecimal(value: String) : Number, Comparable<BigDecimal>

A floating point decimal number with arbitrary precision.

actual class BigDecimal(value: String) : Number, Comparable<BigDecimal>

actual class BigDecimal(value: String) : Number, Comparable<BigDecimal>

expect class BigInteger(value: String) : Number, Comparable<BigInteger>

An arbitrarily large signed integer

actual class BigInteger(value: String) : Number, Comparable<BigInteger>

actual class BigInteger(value: String) : Number, Comparable<BigInteger>

sealed class ByteStream

Represents an abstract read-only stream of bytes

sealed class Document

A Document is used to store arbitrary or unstructured data.

DocumentBuilder

class DocumentBuilder

class FileContent(val file: File, val start: Long = 0, val endInclusive: Long = file.length() - 1) : ByteStream.SourceStream

ByteStream backed by a local file

Functions

fun buildDocument(init: DocumentBuilder.() -> Unit): Document

Builds a Document with the given builder.

fun Document(value: Boolean): Document

Construct a Document from a Boolean.

fun Document(value: Number): Document

Construct a Document from a Number of arbitrary precision.

fun Document(value: String): Document

Construct a Document from a String.

fun Document(value: List<Document?>): Document

Construct a Document from a List.

fun Document(value: Map<String, Document?>): Document

Construct a Document from a Map.

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 ByteArray.asByteStream(): ByteStream

Convert this ByteArray to a ByteStream

fun String.asByteStream(): ByteStream

Convert this String to a ByteStream

fun File.asByteStream(range: LongRange): ByteStream

Create a ByteStream from a file with the given range

fun InputStream.asByteStream(contentLength: Long? = null): ByteStream.SourceStream

Create a ByteStream.SourceStream that reads from this InputStream

fun Path.asByteStream(range: LongRange): ByteStream

Create a ByteStream from a path with the given range

fun File.asByteStream(start: Long = 0, endInclusive: Long = length() - 1): ByteStream

Create a ByteStream from a file

fun Path.asByteStream(start: Long = 0, endInclusive: Long = -1): ByteStream

Create a ByteStream from a path

fun ByteStream.cancel()

suspend fun ByteStream.decodeToString(): String

fun ByteStream.Companion.fromFile(file: File): ByteStream

Create a ByteStream from a file

fromInputStream

fun ByteStream.Companion.fromInputStream(inputStream: InputStream, contentLength: Long? = null): ByteStream.SourceStream

Create a ByteStream.SourceStream that reads from the given InputStream

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 Flow<ByteArray>.toByteStream(scope: CoroutineScope, contentLength: Long? = null): ByteStream

Create a ByteStream from a Flow of byte arrays.

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.