ktor-revfile-core/io.github.janmalch.ktor.revfile/RevFileRegistry

RevFileRegistry

abstract class RevFileRegistry(path: String) : WriteableRevFileRegistry(source)

A registry for revisioned files, scoped under the given path.

package com.example

object AppAssets : RevFileRegistry("/assets/") {
    val main: RevisionedFile = resource("main.js")
    val styles: RevisionedFile = resource("styles.css")
}

fun Application.module() {
    install(RevFilePlugin) {
        +AppAssets
    }
}

Constructors

RevFileRegistry

constructor(path: String)

Functions

create

fun WriteableRevFileRegistry.create(originalName: String, contentType: ContentType = ContentType.defaultForFilePath(originalName), content: () -> OutgoingContent.ReadChannelContent): RevisionedFile

Creates a new custom RevisionedFile and adds it to this WriteableRevFileRegistry.

file

fun WriteableRevFileRegistry.file(file: File, contentType: ContentType = ContentType.defaultForFile(file), name: String = file.name): RevisionedFile

Creates a new RevisionedFile from the given file and adds it to this WriteableRevFileRegistry.

get

operator override fun get(path: String): RevisionedFile?

Returns the revisioned file associated with the given path, or null if no such file exists.

iterator

operator override fun iterator(): Iterator<RevisionedFile>

override fun register(entry: WriteableRevFileRegistry.Entry): RevisionedFile

Registers the given entry and returns its associated revisioned file.

resource

fun WriteableRevFileRegistry.resource(resource: String, name: String = resource.substringAfterLast('/'), contentType: ContentType = ContentType.defaultForFilePath(resource), classLoader: ClassLoader = checkNotNull(this::class.java.classLoader) { "Failed to get a class loader for loading resource '$resource'." }): RevisionedFile

Creates a new RevisionedFile from the given JVM resource and adds it to this WriteableRevFileRegistry.

size

override fun size(): Int

Returns the number of registered files.

source

fun WriteableRevFileRegistry.source(originalName: String, contentType: ContentType = ContentType.defaultForFilePath(originalName), content: () -> Source): RevisionedFile

fun WriteableRevFileRegistry.source(path: Path, contentType: ContentType = ContentType.defaultForFilePath(path.toString()), originalName: String = path.name, fileSystem: FileSystem = SystemFileSystem): RevisionedFile

Creates a new RevisionedFile from the given source and adds it to this WriteableRevFileRegistry.

toString

open override fun toString(): String

uri

fun WriteableRevFileRegistry.uri(uri: URI, name: String = uri.toString().substringAfterLast('/'), contentType: ContentType = ContentType.defaultForFilePath(uri.path)): RevisionedFile

Creates a new RevisionedFile from the given URI and adds it to this WriteableRevFileRegistry.

url

fun WriteableRevFileRegistry.url(url: URL, name: String = url.toString().substringAfterLast('/'), contentType: ContentType = ContentType.defaultForFilePath(url.path)): RevisionedFile

Creates a new RevisionedFile from the given URL and adds it to this WriteableRevFileRegistry.