ktor-http/io.ktor.http.content/TextContent

TextContent

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

Represents a text content that could be sent

Constructors

TextContent

constructor(text: String, contentType: ContentType, status: HttpStatusCode? = null)

Properties

caching

var OutgoingContent.caching: CachingOptions?

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

contentLength

open override val contentLength: Long

Specifies content length in bytes for this resource.

contentType

open override val contentType: ContentType

Specifies ContentType for this resource.

headers

open val headers: Headers

Headers to set when sending this content

status

open override val status: HttpStatusCode? = null

Status code to set when sending this content

text

val text: String

to be sent

versions

var OutgoingContent.versions: List<Version>

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

Functions

bytes

open override fun bytes(): ByteArray

Provides ByteArray which engine will send to peer

compressed

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

Returns OutgoingContent compressed with contentEncoder if possible.

getProperty

open fun <T : Any> getProperty(key: AttributeKey<T>): T?

Gets an extension property for this content

isEmpty

fun OutgoingContent.isEmpty(): Boolean

Check if current OutgoingContent doesn't contain content

setProperty

open fun <T : Any> setProperty(key: AttributeKey<T>, value: T?)

Sets an extension property for this content

toString

open override fun toString(): String

trailers

open fun trailers(): Headers?

Trailers to set when sending this content, will be ignored if request is not in HTTP2 mode