LocalFileContent

class LocalFileContent : ReadChannelContent

OutgoingContent representing a local file with a specified contentType, expires date and caching

Parameters

file - specifies the File to be served to a client

Constructors

<init>

LocalFileContent(
    file: File,
    contentType: ContentType = ContentType.defaultForFile(file))

OutgoingContent representing a local file with a specified contentType, expires date and caching

Properties

contentLength

val contentLength: Long

Specifies content length in bytes for this resource.

contentType

val contentType: ContentType

Specifies ContentType for this resource.

file

val file: File

specifies the File to be served to a client

Functions

readFrom

fun readFrom(): ByteReadChannel

Provides ByteReadChannel for the content

fun readFrom(range: LongRange): ByteReadChannel

Provides ByteReadChannel for the given range of the content

Extension Properties

caching

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

defaultVersions

val OutgoingContent.defaultVersions: List<Version>

Retrieves LastModified and ETag versions from this OutgoingContent headers

versions

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

Extension Functions

toByteArray

suspend fun OutgoingContent.toByteArray(): ByteArray

toByteReadPacket

suspend fun OutgoingContent.toByteReadPacket(): ByteReadPacket

wrapHeaders

fun OutgoingContent.wrapHeaders(
    block: (Headers) -> Headers
): OutgoingContent

Generates a new OutgoingContent of the same abstract type but with OutgoingContent.headers transformed by the specified block.