ktor-http/io.ktor.http.content/URIFileContent

URIFileContent

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

Represents a content that is served from the specified uri

Report a problem

Constructors

URIFileContent

constructor(uri: URI, contentType: ContentType = ContentType.defaultForFilePath(uri.path), contentLength: Long? = null)

constructor(url: URL, contentType: ContentType = ContentType.defaultForFilePath(url.path))

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 val status: HttpStatusCode?

Status code to set when sending this content

uri

val uri: URI

that is used as a source

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.

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

readFrom

open fun readFrom(range: LongRange): ByteReadChannel

Provides ByteReadChannel for the given range of the content

open override fun readFrom(): ByteReadChannel

Provides ByteReadChannel for the content

setProperty

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

Sets an extension property for this content

trailers

open fun trailers(): Headers?

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