ktor-http/io.ktor.http.content

Package-level declarations

Types

class ByteArrayContent(bytes: ByteArray, val contentType: ContentType? = null, val status: HttpStatusCode? = null) : OutgoingContent.ByteArrayContent

Implementation of the OutgoingContent.ByteArrayContent for sending array of bytes

CachingOptions

data class CachingOptions(val cacheControl: CacheControl? = null, val expires: GMTDate? = null)

Specifies caching properties for OutgoingContent such as Cache-Control or Expires.

ChannelWriterContent

class ChannelWriterContent(body: suspend ByteWriteChannel.() -> Unit, val contentType: ContentType?, val status: HttpStatusCode? = null, val contentLength: Long? = null) : OutgoingContent.WriteChannelContent

OutgoingContent to respond with ByteWriteChannel. The stream would be automatically closed after body finish.

EntityTagVersion

data class EntityTagVersion(val etag: String, val weak: Boolean) : Version

This version checks the etag value and pass it through conditions supplied by the remote client. Depending on the conditions, it produces the return value of enum type VersionCheckResult.

LastModifiedVersion

data class LastModifiedVersion(val lastModified: GMTDate) : Version

Creates an instance of LastModifiedVersion that passes the given lastModified date through the If-Modified-Since and If-Unmodified-Since conditional headers provided by the client.

MultiPartData

interface MultiPartData

Represents a multipart data stream that could be received from a call.

NullBody

object NullBody

A subject of pipeline when body of HTTP message is null

OutgoingContent

sealed class OutgoingContent

Information about the content to be sent to the peer, recognized by a client or server engine

OutputStreamContent

class OutputStreamContent(body: suspend OutputStream.() -> Unit, val contentType: ContentType, val status: HttpStatusCode? = null, val contentLength: Long? = null) : OutgoingContent.WriteChannelContent

OutgoingContent to respond with OutputStream. The stream would be automatically closed after body finish.

PartData

sealed class PartData

Represents a multipart/form-data entry. Could be a FormItem or FileItem.

TextContent

class TextContent(val text: String, val contentType: ContentType, val status: HttpStatusCode? = null) : OutgoingContent.ByteArrayContent

Represents a text content that could be sent

URIFileContent

class URIFileContent(val uri: URI, val contentType: ContentType = ContentType.defaultForFilePath(uri.path), val contentLength: Long? = null) : OutgoingContent.ReadChannelContent

Represents a content that is served from the specified uri

Version

interface Version

A content version.

VersionCheckResult

enum VersionCheckResult : Enum<VersionCheckResult>

Represent the result of the version comparison between content being sent and HTTP request.

WriterContent

class WriterContent(body: suspend Writer.() -> Unit, val contentType: ContentType, val status: HttpStatusCode? = null, val contentLength: Long? = null) : OutgoingContent.WriteChannelContent

Represents a content that is produced by body function

Properties

caching

var OutgoingContent.caching: CachingOptions?

Gets or sets the CacheControl instance as an extension property on this content.

CachingProperty

val CachingProperty: AttributeKey<CachingOptions>

Specifies a key for the CacheControl extension property for OutgoingContent.

streamProvider

val PartData.FileItem.~~streamProvider~~: () -> InputStream

Provides file item's content as an InputStream

VersionListProperty

val VersionListProperty: AttributeKey<List<Version>>

Specifies a key for the VersionList extension property for OutgoingContent.

versions

var OutgoingContent.versions: List<Version>

Gets or sets a list of Version instances as an extension property on this content.

Functions

compressed

fun OutgoingContent.compressed(contentEncoder: ContentEncoder, coroutineContext: CoroutineContext = EmptyCoroutineContext): OutgoingContent?

Returns OutgoingContent compressed with contentEncoder if possible.

EntityTagVersion

fun EntityTagVersion(spec: String): EntityTagVersion

Creates an instance of EntityTagVersion parsing the spec via EntityTagVersion.parseSingle.

forEachPart

suspend fun MultiPartData.forEachPart(partHandler: suspend (PartData) -> Unit)

Parse multipart data stream and invoke partHandler for each PartData encountered.

isEmpty

fun OutgoingContent.isEmpty(): Boolean

Check if current OutgoingContent doesn't contain content

LastModifiedVersion

fun LastModifiedVersion(lastModified: Date): LastModifiedVersion

This version passes the given lastModified date through the client provided http conditional headers If-Modified-Since and If-Unmodified-Since.

readAllParts

suspend fun MultiPartData.~~readAllParts~~(): List<PartData>

Parse multipart data stream and put all parts into a list.