http/aws.smithy.kotlin.runtime.http/HttpBody

HttpBody

sealed class HttpBody

HTTP payload to be sent to a peer

Inheritors

Types

abstract class Bytes : HttpBody

Variant of a HttpBody with payload represented as ByteArray

abstract class ChannelContent : HttpBody

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

object Companion

object Empty : HttpBody

Variant of a HttpBody without a payload

abstract class SourceContent : HttpBody

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

Properties

open val contentLength: Long? = null

Specifies the length of this HttpBody content If null it is assumed to be a streaming source using e.g. Transfer-Encoding: Chunked

open val isDuplex: Boolean = false

Flag indicating that this request body should be handled as a duplex stream by the underlying engine.

open val isOneShot: Boolean = true

Flag indicating the body can be consumed only once

Functions

open operator override fun equals(other: Any?): Boolean

Inherited functions

suspend fun HttpBody.readAll(): ByteArray?

Consume the HttpBody 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 HttpBody.toByteStream(): ByteStream?

Convert an HttpBody variant to the corresponding ByteStream variant or null if empty.