http4k-core/org.http4k.core/StreamBody

StreamBody

class StreamBody(val stream: InputStream, val length: Long? = null) : Body

Represents a body that is backed by a (lazy) InputStream. Operating with StreamBody has a number of potential gotchas:

Attempts to consume the stream will pull all of the contents into memory, and should thus be avoided. This includes calling equals() and payload
If this Body is NOT being returned to the caller (via a Server implementation or otherwise), close() should be called.
Depending on the source of the stream, this body may or may not contain a known length.

Constructors

constructor(stream: InputStream, length: Long? = null)

Properties

open override val length: Long? = null

Will be null for bodies where it's impossible to a priori determine - e.g. StreamBody

open override val payload: ByteBuffer

open override val stream: InputStream

Functions

open override fun close()

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

fun Body.gunzipped(): Body

gunzippedStream

fun Body.gunzippedStream(): Body

fun Body.gzipped(compressionLevel: Int = DEFAULT_COMPRESSION): CompressionResult

fun Body.gzippedStream(compressionLevel: Int = DEFAULT_COMPRESSION): CompressionResult

open override fun hashCode(): Int

open override fun toString(): String